因为现有的文档工具不能满足

1. 方便的版本管理
2. 可以加入二进制文件

的需求, 我选择了一个静态页面生成器来写文档.

• hugo, 使用go, 一个可执行文件就可以跑,方便
• hugo-flex, 主题, 看起来还不错
• hugoBasicExample 看看语法,就可以上手了

运行的命令是hugo server --port 80 --bind x.x.x.x --disableFastRender -b http://x.x.x.x, hugo会 自动的追踪所有对页面和元数据的更改并重新编译,记得把这里的x.x.x.x替换为ip.

hugo的文章都放在content/post目录下, 使用markdown格式, 头部是自己定义的元数据, 比如, 下面这样添加了tag和category, 设置了标题.

+++
title = "使用hugo"
date = "2019-04-30"
description = "使用hugo搭建静态页面"
tags = [
    "hugo", "page-generator"
]
categories = [
    "其他"
]
+++

当编写完成需要生成页面时, 使用hugo --baseUrl=http://site来把生成的页面放入public/目录

添加语法高亮支持,在config.toml中加入两行即可

pygmentsCodefences = true
pygmentsStyle = "pygments"

下面是一段简短的代码

def hello():
    pass