Skip to content

写作与目录约定 ​

目录 ​

位置用途
docs/公开文档与笔记
docs/private/需要密码访问的内容
docs/public/图片、图标等静态资源

命名 ​

  • 目录首页统一使用 index.md
  • 文件名使用小写英文和短横线,例如 design-system.md
  • 中文标题写在页面的一级标题里,不写进文件名

私密内容 ​

私密页面放在 docs/private/ 下。构建后对应页面与 chunk 由 EdgeOne 中间件拦截,未登录不会下发内容。不要在公开导航或正文里链接私密页面,未登录时的客户端跳转体验不好。