zhuhanxin/docskit repository overview

⁠DocsKit

DocsKit 是一个由 Markdown 文件夹驱动的轻量文档站点。它会递归扫描指定目录，将子目录转换为分级侧边栏，将 Markdown 文件渲染为可搜索、可导航的文档页面。

⁠特性

• 递归解析 .md 和 .markdown 文件。
• 根据目录结构自动生成多级侧边栏。
• 支持标题、段落、列表、表格、引用、代码块、图片和相对链接。
• 支持 front matter 配置标题、摘要、排序和图标。
• 侧边栏图标、顶部导航、品牌信息和主题开关均可配置。
• 服务端全文搜索标题、路径和 Markdown 正文。
• 文档索引按需构建并缓存在内存中，文件变化后下一次请求自动失效重建。
• 支持浅色/深色主题和移动端导航抽屉。
• 不主动刷新页面；修改文档、目录结构或配置后，刷新浏览器即可看到最新结果。

运行镜像：

docker run --rm -p 3000:3000 zhuhanxin/docskit

上面的命令使用镜像内置的 docs/ 内容。若希望在容器运行期间编辑宿主机文档和配置，可以挂载 docs/ 目录：

docker run --rm -p 3000:3000 \
  -v "$PWD/docs:/app/docs" \
  zhuhanxin/docskit

挂载后，修改宿主机 docs/ 下的 Markdown 文件、目录结构或 docs.config.json，刷新浏览器即可看到变化。

git仓库 https://github.com/test2024124zyx/docskit⁠