Web Docs
这个目录放的是仓库文档站的实现代码。
启动
在仓库根目录执行:
npm install
npm run docs:web
默认监听:
http://127.0.0.1:4321
也可以通过环境变量修改:
HOST=0.0.0.0 PORT=8080 npm run docs:web
设计原则
- 直接读取仓库现有 Markdown,不复制一套文档。
- 目录、Markdown、YAML、JSON、TXT、脚本文件都能在网页里直接打开。
- 兼容仓库里已有的绝对路径链接和相对路径链接。
- 自动生成左侧导航、搜索索引和目录浏览页。