文档 - md文件写作
# 推荐写作软件
推荐写 markdown
软件
Typora
下载即用
vs code
需要下载 markdown 插件
里面终端可设置
git bash
终端,方便调试,适合程序员使用
# 图片要求
图片地址必须是可在线访问的链接,不能是本地图片
可以用 GitHub+PicGo+jsDelivr 搭建免费图床
如何免费搭建图床,并在markdown中使用教程:https://oddfar.com/archives/91/ (opens new window)
# 文件命名约定
- 无论是文件还是文件夹,请为其名称添加上正确的正整数序号和
.
,从00
或01
开始累计,如01.文件夹
、02.文件.md
,我们将会按照序号的顺序来决定其在侧边栏当中的顺序。 - 同一级别目录别内即使只有一个文件或文件夹也要为其加上序号。
- 文件或文件夹名称中间不能出现多余的点
.
,如01.我是.名称.md
中间出现.
将会导致解析错误。
序号只是用于决定先后顺序,并不一定需要连着,如01、02、03...
,实际工作中可能会在两个文章中间插入一篇新的文章,因此为了方便可以采用间隔序号10、20、30...
,后面如果需要在10
和20
中间插入一篇新文章,可以给定序号15
。
# 级别说明
源目录(一般是docs
)底下的级别现在我们称之为一级目录
,一级目录
的下一级为二级目录
,以此类推,最多到四级目录
。
- 一级目录
.vuepress
、@pages
、_posts
、index.md 或 README.md
这些文件(文件夹)不参与数据生成。- 序号非必须。(如一些专栏,可以不用序号)
- 二级目录
- 该级别下可以同时放文件夹和
.md
文件,但是两者序号要连贯(参考下面的例子中的其他
)。 - 必须有序号
- 该级别下可以同时放文件夹和
- 三级目录
- (同上)
- 四级目录
- 该级别下只能放
.md
文件。 - 必须有序号
- 该级别下只能放
所有级别内至少有一个文件或文件夹。
vdoing主题介绍文档:https://doc.xugaoyi.com/pages/33d574/
在 GitHub 上编辑此页 (opens new window)
最后更新: 2021/08/03, 15:08:00