导航
导航
文章目录
  1. 标题
  2. 空白行与空格
  3. 代码块
  4. 参考资料

自用markdown写文章格式规范

标题

一级标题使用#,即markdown默认h1,同时设置fexo主题,h1加下划线,如果一级标题下有子项,使用##,最多只能嵌套一层,否则标题前加数字区分如1 1.1 1.1.1,最多嵌套两层。

空白行与空格

  • 标题前后加多一空白行;
  • 区块引用>后面加多一空白行;
  • 代码块前后加多一空白行
  • 若需要在段落内换行,在行结尾处使用三个空格;
  • 每段结束后,加多三个空格;
  • 链接文字前后加一个空格

代码块

代码块都要注明代码类型。

由于json不能添加注释,如果需要添加注释以便更好阅读,用js类型替换

参考资料

【1】Markdown 语法说明 (简体中文版)