Docsify官网开源GitHub31.4K Star5.8K Fork文档网站生成器不会生成静态HTML文件。通过轻量级JS引擎在运行时直接动态加载并解析Markdown文件。设计理念无需静态构建只需把Markdown文件往服务器上一放用户访问时浏览器会自动渲染极简配置通过全局变量window.$docsify即可完成几乎所有功能的配置门槛极低多主题支持官方提供多款清新脱俗的主题也支持自定义CSS轻松打造个性化界面插件生态强大核心极其轻量插件系统如全文搜索、代码高亮、图片缩放、Emoji渲染、目录折叠都能通过引入一行脚本轻松实现响应式设计原生支持移动端文档在手机和平板上依然拥有极佳的阅读体验。实战npmi docsify-cli-gdocsify init ./docs docsify serve ./docs./docs目录下会生成三个核心文件index.html入口文件包含配置信息README.md默认的主页内容.nojekyll用于防止GitHub Pages忽略以底杠开头的目录浏览器访问http://localhost:3000就能看到漂亮的文档界面。!DOCTYPEhtmlhtmlheadmetacharsetUTF-8title我的技术手册/titlelinkrelstylesheethref//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css/headbodydividapp加载中.../divscriptwindow.$docsify{name:My Docs,// 项目名称repo:https://github.com/docsifyjs/docsify,// 右上角挂件地址loadSidebar:true,// 开启侧边栏定制subMaxLevel:3,// 目录显示到三级标题search:{placeholder:搜索,// 搜索框占位符noData:找不到结果,depth:6}}/scriptscriptsrc//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js/scriptscriptsrc//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js/scriptscriptsrc//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js/scriptscriptsrc//cdn.jsdelivr.net/npm/prismjs/components/prism-python.min.js/script/body/html解读通过简单的JS对象配置侧边栏和搜索功能。当你需要增加新的文档章节时只需修改_sidebar.md文件并新建Markdown即可完全不需要重新运行任何构建命令。对比GitBookGitBook曾经是行业标准但由于其商业化转型和CLI停止维护使用体验逐渐下滑。比GitBook更轻、更自由且完全开源免费与VuePress/VitePress对比VuePress在构建SEO友好的静态页面方面更胜一筹因为它会预渲染HTML但它的配置相对复杂且每次修改都需要npm run build。如果你是做一个内部项目手册或对SEO要求不是极高Docsify的“即时渲染”优势将节省大量时间。资源消耗Docsify只有一个文件不仅托管方便对服务器的存储压力也几乎为零。GitBook官网开源GitHub29K Star4.1K Fork现代化的文档平台支持团队协作可以在上面写产品文档、内部知识分享、接口文档等。官方文档中文文档。GitHub双向集成在GitBook上创建的文档可同步到GitHub仓库每次对文档的修改都会生成一个提交GitBook会自动推送到GitHub反之往GitHub提交的内容也会自动同步到GitBook。实战至少有两种使用方式官方SaaS平台本地部署打开SaaS平台使用GitHub授权登录有5种开始方式文档模板、导入文档、从头开始、OpenAPI、Git同步。以导入为例支持本地文件如markdown导入md文件仅133KB看起来导入成功刷新后啥也没有别慌数据都在看下文创建工作空间space空间是由一个个块block组成可对任一块进行评论空间支持的导出操作点击空间的预览preview变成文档站点doc site文档站点支持的操作在文档站点内点击右上角的编辑Edit添加页Page页支持多种类型还是导入本地文件来得最快这次换个小文档1个12KB的md文件十几秒左右导入。记得点击右上角的Merge发起合并否则文档的更改不生效。点击页面右上角的变更请求Change requests可看到之前的导入动作再看看页面右上角按钮出现【更新Update】按钮是因为这个变更请求是更早发起的但一直未合并。不熟悉GitBook操作流程和路径重试导入文档已合并更晚的请求提交。此时直接点击合并Merge会再次提醒官方推荐更新Update而不是强制合并可能会发生冲突但这不就导致已合并的文档发生丢失吗别慌点击右侧的对比操作区点击被删除的页点击右侧的更多选择【Restore deleted page】两个Page都得到保留终于来到GitHub集成点击右上角当前支持GitHub和GitLab选择仓库此处需要提前到GitHub新增仓库新打开的跳转标签页只有读权限在跨平台集成场景下也很正常GitHub给GitBook开放读取权限。这个地方又踩了坑先在GitBook创建3个Page然后选择同步一个空的GitHub仓库选择同步后GitHub空仓库把GitBook给覆盖GitBook页面都没了。。。这啥啊别慌在GitHub里有版本控制概念可以时空穿梭GitBook是不是也可以点击已同步Synced图标点击配置同步来到页面选择下次同步Next sync按钮点击保存。点击图标查看版本历史如上图这就是此前说的变更请求合并顺序3-1-2。点击版本记录更多按钮有5个操作2个是版本相关选为基础版本Select as base version、回滚到此修订Revert to this revision另外3个预览和复制。点击删除动作版本的前一个版本点击更多按钮回滚到此修订。GitBook页面正常注意看这里的页顺序。再看看GitHub有一次自动提交几个观察提交者是机器人gitbook-botGitHub之前的README.md是空白的自动把Page1也就是PG.md替换掉README.md自动生成SUMMARY.md即目录列表概述overview可借助于AI生成库library类型有5种AI增强体现在各个方面除了上面的概述生成。在页顶部除了搜索框有个Ask按钮默认打开GitBook Assistant这也是AI集成最最常见的形式底层使用的模型暂未可知。对页发起提问Ask还有其他生态集成形式如打开ChatGPT或类似网页端应用阅读此页面需要应用支持联网能力进而发起提问。Agent基于源码本地部署gitclone https://github.com/gitbookIO/gitbook.git buninstallbun devDocmd官网基于Node.js的开源GitHub2.2K Star120 Fork命令行工具用于从标准Markdown文件生成轻量级静态文档网站。遵循内容至上理念强调编写与阅读的高效和简洁体验。功能原生Markdown支持兼容标准Markdown与YAML frontmatter多主题与暗色模式内置语法高亮与多种样式方案轻量与快速纯静态网站生成依赖最少JS自定义组件支持提示框、卡片、步骤等扩展元素内置插件集成SEO、统计分析、站点地图等功能自由页面可创建无样式的独立页面完全控制HTML内容自定义样式与脚本支持在frontmatter中直接添加CSS/JS简洁CLI命令提供init、dev、build等核心命令自由部署可在GitHub Pages、Netlify、Vercel等任意平台发布实战基于npm安装npminstall-gmgks/docmdnpminstall--save-dev mgks/docmd# 项目维度安装docmd init docmd dev docmd build
