Doctave 新手教程10 分钟学会用 Markdown 写出专业级技术文档【免费下载链接】doctaveA batteries-included developer documentation site generator项目地址: https://gitcode.com/gh_mirrors/do/doctave想为你的开源项目写一份漂亮、专业的技术文档却不想折腾复杂的静态网站生成器Doctave 正是一款专为开发者文档而生的 Markdown 文档站点生成器它由 Rust 编写开箱即用、几乎零配置只需一条命令就能把纯 Markdown 文件转换成带搜索、导航和暗黑模式的现代化文档站点。本教程将带你用 10 分钟快速上手从安装到发布一气呵成。为什么选择 Doctave文档站生成器的极简之选市面上的静态站点生成器往往功能庞杂配置繁琐。Doctave 则刻意保持简单——它只做文档站不做通用网站。这意味着你不需要学习复杂的主题系统也不需要写一堆配置文件就能获得以下开箱即用的能力Mermaid.js 图表流程图、时序图、状态图直接写进 Markdown离线全文搜索无需任何后端服务本地热重载服务器改完代码浏览器自动刷新断链检查自动发现失效链接数学公式排版基于 KaTeX支持 TeX 语法暗黑模式 响应式设计⚡超快构建速度得益于 Rust 语言site_generator.rs 让构建以毫秒计上图就是 Doctave 生成的文档站点效果左侧是清晰的导航目录顶部有全局搜索框正文排版干净利落右侧还有本页目录快速跳转。整套界面开箱即得完全不用写一行 CSS。一键安装步骤三种方式任选Doctave 支持 Mac、Linux 和 Windows安装非常简单。方式一预编译二进制推荐 直接下载对应平台的安装包解压即可使用。方式二HomebrewmacOS$ brew install doctave/doctave/doctave方式三CargoRust 开发者$ cargo install --git https://gitcode.com/gh_mirrors/do/doctave --tag 0.4.2安装完成后运行doctave --version验证是否成功。安装细节可参考 docs/installing.md。最快配置方法init serve 两命令跑起来第一步初始化文档站点在一个空目录里执行$ doctave init这个命令会自动创建docs/目录和doctave.yaml配置文件并附带几个示例页面。init.rs 负责这一整套初始化流程。第二步启动本地预览服务器$ doctave serve看到Server running on http://0.0.0.0:4001/后浏览器打开http://localhost:4001你的技术文档就上线了更棒的是修改任何 Markdown 文件浏览器都会自动刷新配合 livereload_server.rs 的热重载能力写作体验丝滑流畅。添加新页面只需新建一个 Markdown 文件在 Doctave 中一个 Markdown 文件就是一个页面。比如新增一篇构建指南$ touch docs/building.md然后用 Markdown 编写内容并通过 YAML 前置数据front matter设置页面标题--- title: How to build --- # How to build ...保存后回到浏览器左侧导航栏会立刻出现新页面的链接。想要调整导航顺序编辑doctave.yaml中的navigation配置即可参考 docs/configuration.md 和 navigation.rs。让文档更专业的四个进阶技巧技巧一插入 Mermaid 图表用 Markdown 代码块就能渲染专业图表只需把语言标记为mermaid流程图、时序图、状态图、饼图统统支持详细语法见 docs/features/mermaid-js.md。技巧二排版数学公式指定代码块语言为mathDoctave 会用 KaTeX 渲染出漂亮的公式排版math x^2 - 5x 6 0 \\ (x-2)(x-3)0适合算法、机器学习类项目的技术文档示例见 [docs/features/math-notation.md](https://link.gitcode.com/i/ec0bd22feab470d00003a8f13115448b)。 ### 技巧三更换主题色与 Logo 在 doctave.yaml 中设置主色调Doctave 会自动计算整套配色方案暗黑模式下还会自动提亮保证对比度 yaml --- title: My Project colors: main: #5f658a logo: assets/logo.png只需两步——把 Logo 放到docs/_include目录下再在配置里指定路径即可详见 docs/features/look-and-feel.md。技巧四使用 Callout 提示框Doctave 支持info、success、warning、error四种提示框让重点信息一目了然{% warning 注意 %} 部署到子目录时记得设置 base_path {% end %}发布上线一条命令构建静态站点写完后执行构建命令$ doctave build --releaseDoctave 会生成一个完全自包含的site/静态目录不依赖任何运行时。你可以把它部署到任意静态托管平台也可以部署到子路径只需在doctave.yaml中设置base_path发布流程详见 docs/deployment.md。总结短短 10 分钟你已经完成了 Doctave 从安装、写作、美化到部署的全流程。作为一个专为技术文档而生的 Markdown 文档站点生成器Doctave 用极简的设计帮你把精力从折腾工具转移到写好内容上。无论是个人项目还是团队内部文档它都能让你的文档立刻专业起来。现在就去试试吧你的下一篇技术文档值得更好的呈现【免费下载链接】doctaveA batteries-included developer documentation site generator项目地址: https://gitcode.com/gh_mirrors/do/doctave创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Doctave 新手教程：10 分钟学会用 Markdown 写出专业级技术文档
Doctave 新手教程10 分钟学会用 Markdown 写出专业级技术文档【免费下载链接】doctaveA batteries-included developer documentation site generator项目地址: https://gitcode.com/gh_mirrors/do/doctave想为你的开源项目写一份漂亮、专业的技术文档却不想折腾复杂的静态网站生成器Doctave 正是一款专为开发者文档而生的 Markdown 文档站点生成器它由 Rust 编写开箱即用、几乎零配置只需一条命令就能把纯 Markdown 文件转换成带搜索、导航和暗黑模式的现代化文档站点。本教程将带你用 10 分钟快速上手从安装到发布一气呵成。为什么选择 Doctave文档站生成器的极简之选市面上的静态站点生成器往往功能庞杂配置繁琐。Doctave 则刻意保持简单——它只做文档站不做通用网站。这意味着你不需要学习复杂的主题系统也不需要写一堆配置文件就能获得以下开箱即用的能力Mermaid.js 图表流程图、时序图、状态图直接写进 Markdown离线全文搜索无需任何后端服务本地热重载服务器改完代码浏览器自动刷新断链检查自动发现失效链接数学公式排版基于 KaTeX支持 TeX 语法暗黑模式 响应式设计⚡超快构建速度得益于 Rust 语言site_generator.rs 让构建以毫秒计上图就是 Doctave 生成的文档站点效果左侧是清晰的导航目录顶部有全局搜索框正文排版干净利落右侧还有本页目录快速跳转。整套界面开箱即得完全不用写一行 CSS。一键安装步骤三种方式任选Doctave 支持 Mac、Linux 和 Windows安装非常简单。方式一预编译二进制推荐 直接下载对应平台的安装包解压即可使用。方式二HomebrewmacOS$ brew install doctave/doctave/doctave方式三CargoRust 开发者$ cargo install --git https://gitcode.com/gh_mirrors/do/doctave --tag 0.4.2安装完成后运行doctave --version验证是否成功。安装细节可参考 docs/installing.md。最快配置方法init serve 两命令跑起来第一步初始化文档站点在一个空目录里执行$ doctave init这个命令会自动创建docs/目录和doctave.yaml配置文件并附带几个示例页面。init.rs 负责这一整套初始化流程。第二步启动本地预览服务器$ doctave serve看到Server running on http://0.0.0.0:4001/后浏览器打开http://localhost:4001你的技术文档就上线了更棒的是修改任何 Markdown 文件浏览器都会自动刷新配合 livereload_server.rs 的热重载能力写作体验丝滑流畅。添加新页面只需新建一个 Markdown 文件在 Doctave 中一个 Markdown 文件就是一个页面。比如新增一篇构建指南$ touch docs/building.md然后用 Markdown 编写内容并通过 YAML 前置数据front matter设置页面标题--- title: How to build --- # How to build ...保存后回到浏览器左侧导航栏会立刻出现新页面的链接。想要调整导航顺序编辑doctave.yaml中的navigation配置即可参考 docs/configuration.md 和 navigation.rs。让文档更专业的四个进阶技巧技巧一插入 Mermaid 图表用 Markdown 代码块就能渲染专业图表只需把语言标记为mermaid流程图、时序图、状态图、饼图统统支持详细语法见 docs/features/mermaid-js.md。技巧二排版数学公式指定代码块语言为mathDoctave 会用 KaTeX 渲染出漂亮的公式排版math x^2 - 5x 6 0 \\ (x-2)(x-3)0适合算法、机器学习类项目的技术文档示例见 [docs/features/math-notation.md](https://link.gitcode.com/i/ec0bd22feab470d00003a8f13115448b)。 ### 技巧三更换主题色与 Logo 在 doctave.yaml 中设置主色调Doctave 会自动计算整套配色方案暗黑模式下还会自动提亮保证对比度 yaml --- title: My Project colors: main: #5f658a logo: assets/logo.png只需两步——把 Logo 放到docs/_include目录下再在配置里指定路径即可详见 docs/features/look-and-feel.md。技巧四使用 Callout 提示框Doctave 支持info、success、warning、error四种提示框让重点信息一目了然{% warning 注意 %} 部署到子目录时记得设置 base_path {% end %}发布上线一条命令构建静态站点写完后执行构建命令$ doctave build --releaseDoctave 会生成一个完全自包含的site/静态目录不依赖任何运行时。你可以把它部署到任意静态托管平台也可以部署到子路径只需在doctave.yaml中设置base_path发布流程详见 docs/deployment.md。总结短短 10 分钟你已经完成了 Doctave 从安装、写作、美化到部署的全流程。作为一个专为技术文档而生的 Markdown 文档站点生成器Doctave 用极简的设计帮你把精力从折腾工具转移到写好内容上。无论是个人项目还是团队内部文档它都能让你的文档立刻专业起来。现在就去试试吧你的下一篇技术文档值得更好的呈现【免费下载链接】doctaveA batteries-included developer documentation site generator项目地址: https://gitcode.com/gh_mirrors/do/doctave创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考