博客文档写作规范

一. 文档写作

所有写作均使用 markdown 语法, 个人文档总结地址

二. 在 markdown 基础上, 添加层次级别, 方便阅读

  • 为给博客文章添加层次, 增加易读性, 使用如下层级表示方法, 其中, 无标号, 不建议使用 部分, 能不用则不用, 必要时考虑文章拆分.
级别 文字表示 markdown 级别
一级 不要用, 留给文章标题 #
二级 一, 二, 三, 四, 五 …, ##
三级 (一), (二), (三), (四), (五) …, ###
四级 1, 2, 3, 4, 5, 代替有序列表 ####
五级 1.1, 1.2 1.3, 1.4 ,1.5 … #####
六级 1.1.1, 1.1.2, 1.1.3 … ######
列表(七级) 无序列表 -
  • 不要在文章中使用有序列表, 需要使用时, 使用 #### 1. 代替;
  • 只能使用无序列表表示序列;
  • 关闭 nexT 提供的侧边栏的自动索引, 手动提供标题和索引.
  • 各个等级之间必须连续出现, 不能跨越, 否则 hexo 显示或有问题.

三. 博客模板

模板使用 Hexo, 基于 github page, 使用 nexT.Mist 主题, 文档地址: Hexo-nexT-博客建设指南.

另, hexo 在解析 markdown 文档时, 可能会在解析 `{{ }}`, `{% %}` 时 发生错误, 建议在两个符号之间添加空格替代之.

{% raw %}    
        {{  --> { {
        }}  --> } }
        {%  --> { %
        %}  --> % }  
    {% endraw %}    

五. cnblog 使用 JS 在文档右侧显示目录 已弃用

(一) 申请 js 权限

(二) 上传文件

里面的 js 和 css 文件

https://github.com/ctxsdhy/cnblogs-example/tree/master/1-%E5%8D%9A%E5%AE%A2%E5%9B%AD%E6%96%87%E7%AB%A0%E8%87%AA%E5%8A%A8%E7%94%9F%E6%88%90%E5%AF%BC%E8%88%AA%E7%9B%AE%E5%BD%95

(三) 修改页面设置

示例

(四) 参考链接

#### 参考链接:
[title](http://www.example.com/p/1234.html) 
[title](http://www.example.com/p/1234.html)