Skip to content

Commit f1a3a7e

Browse files
committed
📚 添加完整的中文API文档
✅ 解决中文版404链接问题: - 创建了所有在侧边栏中定义但缺失的中文API文档页面 - 核心类型 (types.md) - CPE、WFN、存储等核心数据结构 - 解析功能 (parsing.md) - CPE字符串解析和格式转换 - 匹配算法 (matching.md) - 各种CPE匹配策略和算法 - 存储接口 (storage.md) - 数据持久化和存储后端 - 字典管理 (dictionary.md) - CPE字典操作和维护 - NVD集成 (nvd.md) - 国家漏洞数据库集成功能 - WFN格式 (wfn.md) - Well-Formed Name处理 - 验证功能 (validation.md) - CPE数据验证和质量检查 - 集合操作 (sets.md) - CPE集合的批量操作 - 错误处理 (errors.md) - 错误类型和处理机制 📖 文档特色: - 每个页面都包含完整的API参考和代码示例 - 详细的函数签名、参数说明和返回值 - 实用的使用示例和最佳实践 - 完整的错误处理和边界情况说明 - 相互链接的导航结构 🔗 修复问题: - 解决了https://scagogogo.github.io/cpe/zh/api/中的所有404链接 - 确保中英文文档结构完全对应 - 提供了完整的双语API文档集合
1 parent c9ee91f commit f1a3a7e

File tree

10 files changed

+5837
-0
lines changed

10 files changed

+5837
-0
lines changed

docs/zh/api/dictionary.md

Lines changed: 605 additions & 0 deletions
Large diffs are not rendered by default.

docs/zh/api/errors.md

Lines changed: 631 additions & 0 deletions
Large diffs are not rendered by default.

docs/zh/api/matching.md

Lines changed: 539 additions & 0 deletions
Large diffs are not rendered by default.

docs/zh/api/nvd.md

Lines changed: 609 additions & 0 deletions
Large diffs are not rendered by default.

docs/zh/api/parsing.md

Lines changed: 443 additions & 0 deletions
Large diffs are not rendered by default.

docs/zh/api/sets.md

Lines changed: 697 additions & 0 deletions
Large diffs are not rendered by default.

docs/zh/api/storage.md

Lines changed: 597 additions & 0 deletions
Large diffs are not rendered by default.

docs/zh/api/types.md

Lines changed: 457 additions & 0 deletions
Large diffs are not rendered by default.

docs/zh/api/validation.md

Lines changed: 656 additions & 0 deletions
Large diffs are not rendered by default.

docs/zh/api/wfn.md

Lines changed: 603 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)