本项目fork自https://github.com/hyperqing/lightdoc 感谢作者Guangqing Li
本项目是个一个比较轻量级的项目文档主题,支持:
- 按层次组织文档
- 流程图
- 表格
- 数学公式
特点:
- 简单轻量
- 少有的项目主题
- 方便定制
-
配置
_config.yml
修改其中的:
title
: 项目标题email
: 项目开发者emailkeywords
: 项目主题description
: 项目简介baseurl
: 基url,方便那些使用第一级uri区分项目的用法 # 域名xxx.com直接访问本项目的填'/',带目录域名xxx.com/example访问本项目的填'/example/'url
: 项目域名# "http://0.0.0.0:4000" # 域名
-
项目主页可以使用
markdown
修改index.html
文件 -
项目文档放在
docs
文件夹下,格式请看例子 -
项目的目录通过修改
_includes/gen_sidebar.html
修改