跳到主要内容

文档组织

命名

一般情况下,文件和文件夹全部使用英文小写字母,多个单词使用连接号(-)代替空格。

文件和文件夹名开头使用数字设置排序,如 10-foo.md20-bar/index.md,为了便于后续添加文件,请使用 10 的倍数作为文件名开头。

注意

特殊情况下,可以使用大写字母等其他 ASCII 字符。

禁止使用 ASCII 范围外字符(如汉字等)作为文件、文件夹名称。

ASCII 表
ASCII 表

文档组织

每个文件夹中的 index.md 为该文件夹的默认页面,如 /docs/meta/10-edit-help/20-folder-structure/index.md 在浏览时使用 /meta/edit-help/folder-structure/ 即可访问。

因此,当一个文档(如 10-foo/20-bar.md)需要包含媒体文件时,应建立同名的文件夹(10-foo/20-bar/) 进行存放,并将文档移动到文件夹内(10-foo/20-bar/index.md)。如图:

文件组织结构
文件组织结构

即图片存储于和原页面同名的文件夹内。

注意

不要上传大小超过 50MiB 的文件,如有需要请联系管理员。

目录结构

文档

文档内容存放于 /docs 文件夹。可以任意建立多层文件夹形成树形的组织结构。

博客

博客内容存放于 /blog 文件夹,使用 YYYY/MM-dd-blog-title/YYYY/MM-dd-blog-title.md 存放博客文章。

页面

页面内容存放于 /src/pages 文件夹,与文档类似。请勿定义与文档 URL 冲突的页面。