nuco-docsify

nuco基于docsify定制的文档模板仓库

推荐您使用 nbc 作为commit规范化工具; 如果您在前端项目中使用本仓库模板, 建议您使用commitlint作为工程commit规范工具

✨ Features

• 定制侧边栏
• 定制导航栏
• 支持全文搜索
• 支持emoji
• 支持代码粘贴
• 支持字数统计
• 支持分页
• go语言语法高亮
• 支持PWA
• 支持夜间模式
• 支持Footer信息

Usage

• 修改./docs下的模板文件index.html, 修改其中的meta和title以做正确的SEO优化
• 修改window.$docsify的配置项自定义功能
• 修改其中的README.md和guide.md文件, 做好读者引导
• 修改<script>的内容适当增删插件

使用nbc

我们很高兴的通知您, 自 nbc v1.2.x 版本开始, nbc 已经可以支持命令行生成文档与预览文档了!

# 在当前目录下, 生成docs目录并且根据模板初始化文档
nbc docs

预览文档

# 预览当前目录的docs子目录的文档
nbc serve

更多高级用法, 请参考 nbc文档

Preview

如果您已使用nbc, 则可以跳过这一节

使用docsify-cli

docsify serve docs

不使用docsify-cli

如果本地有静态服务器启动的命令行工具的话, 可以进入./docs文件夹之后启动服务

• 比如nodejs的http-server

cd docs

hs

• 比如nodejs的serve

cd docs

serve

• 比如使用Python

cd docs && python -m SimpleHTTPServer 3000

References

• Docsify官方文档