项目文档配置指南 ⚙️
欢迎查看 project_documentation/config 的配置说明!以下是核心配置项及使用建议:
基础设置
- 文档存储路径:
/docs/storage
(可自定义) - 缓存策略:
cache: true
(默认启用) - 语言切换:支持
/en/xxx
或/zh/xxx
格式(如需多语言)
- 文档存储路径:
安全选项
- 访问权限:通过
auth: false
禁用或启用身份验证 - 敏感内容过滤:
filter: true
(自动屏蔽违规信息) - 日志记录:
log: true
(建议生产环境开启)
- 访问权限:通过
扩展功能
- 链接到项目概述:点击查看项目简介 📘
- 集成第三方工具:如 Markdown 编辑器、版本控制系统等
- 自定义主题:通过
theme: "dark"
或theme: "light"
设置
配置示例:
config: storage: "/docs/storage" cache: true auth: false filter: true log: true
如需进一步优化配置,可参考 项目配置最佳实践。