类似GitBook的文档构建工具

简介: 类似GitBook的文档构建工具

1、前言


前面,我们已经介绍过很多的文档构建工具,比如Docsify、MkDocs、Nikola、Pelican等等。今天我们来介绍一款号称是GitBook替代者的文档构件工具,它就是MdBook。

MdBook是一款使用Rust开发的文档构建工具,它特别轻量,不依赖开发环境,仅仅一个可执行文件就能完成文档构建。而且构建出的文档网站具备代高亮、本地搜索、markdown渲染等功能。


2、MdBook实践


2.1、获取MdBook


我们从MdBook的Github release页面去根据操作系统下载我们需要的软件包即可。

下载解压后,就可以得到mdbook.exe,我们在mdbook.exe所在路径下直接使用mdbook.exe即可进行项目创建和开发了。


2.2、创建项目


我们可以对当前目录进行初始化,也能指定文件夹进行初始化。


创建项目命令:mdbook.exe init ./docs


2.3、项目结构


docs/
├── book
├── book.toml
└── src
    ├── chapter_1.md
    └── SUMMARY.md
复制代码


以上,book是mdbook帮我们构建完的静态工程,book.toml是项目的配置文件,src才是原始的md文档。


我们向src中增加一个目录,然后向其中添加一个md文件,启动mdbook的开发服务器查看效果。


2.4、预览文档


命令:.\mdbook.exe serve .\doc\


网络异常,图片无法展示
|


如上,mdbook构建的文档和gitbook还是非常相似的。


2.5、自定义侧边栏


mdbook的侧边栏是在项目根目录下的SUMMARY.md中定义的, 我们只需要将我们自己开发的文档在SUMMARY.md中进行配置,即可实现侧边栏导航。


SUMMARY.md


# Summary
- [Chapter 1](./chapter_1.md)
- [我自己的文档](./chapter_2.md)
  - [安装](./panyun/hostover_install.md)
  - [升级](./dsds.md)
复制代码


文档结构


└─src
        │  chapter_1.md
        │  chapter_2.md
        │  dsds.md
        │  SUMMARY.md
        │
        └─my
                hostover_install.md
                hostover_portal_upgrade.md
                hostover_upgrade.md
复制代码


预览效果


网络异常,图片无法展示
|


mdbook支持配置SUMMARY.md自动生成文件,非常适合预先构建文档结构的场景。


3、小结


经过简单的使用体验,我们可以发现mdbook构建文档是非常的简单,但是它也存在一些问题。


  1. 不支持中文搜索。
  2. 不支根据文档标题自动生成侧边目录。
  3. 代码块行间距太小。
  4. 不支持提示块。
  5. 不支持顶部导航。


新兴项目能做到这样已经很不错了,期待mdbook越来越好。

相关文章
|
缓存 NoSQL 关系型数据库
|
XML API 数据格式
天气预报API接口
原文:天气预报API接口 一、中央气象台API接口: 1.
19579 0
|
机器学习/深度学习 人工智能 运维
什么是AIOps智能运维?
AIOps(智能运维)是一种利用人工智能和机器学习技术的软件,用于实时分析和处理业务和运营数据,以提供规范性和预测性答案。它通过收集和汇总大量数据,并使用智能筛选和识别重要事件和模式,帮助团队快速解决问题并避免事件发生。AIOps不依赖于人为指定规则,而是通过机器学习算法自动学习和提炼规则。它可以分析异常告警、故障分析、趋势预测等,并在某些情况下自动解决问题。AIOps的团队包括SRE团队、开发工程师团队和算法工程师团队,他们在AIOps相关工作中扮演不同的角色。
|
JavaScript
设置npm淘宝镜像
设置npm淘宝镜像
设置npm淘宝镜像
|
8月前
|
人工智能 运维 监控
保姆级教程 |Coze 人工智能应用开发平台全解析
想从零开始搭建专属AI Agent却不知从何入手?Coze生态提供了一站式解决方案:通过Coze Studio开发平台快速构建Agent,利用Coze Loop调试工具进行全生命周期管理。本文将从环境安装、LLM与嵌入模型配置入手,通过清晰的代码与配置文件修改示例,助你快速上手,开启高效AI应用开发之旅。
|
8月前
|
人工智能 运维 数据安全/隐私保护
保姆级教程:OpenClaw(Clawdbot)本地部署+阿里云1键部署及iMessage集成指南
2026年,OpenClaw(原Clawdbot)已成为轻量化、高可用的开源AI智能体框架,支持本地私有化部署与阿里云云端稳定运行,可无缝对接iMessage实现苹果生态全设备AI交互。本文从零开始,提供本地部署、阿里云一键部署、iMessage消息通道集成的完整流程,附带可直接执行的代码命令、权限配置、端口放行、服务自启与问题排查方案,全程无多余平台信息,新手也能一次性跑通。
3656 1
|
9月前
|
人工智能 测试技术 开发者
AI Coding后端开发实战:解锁AI辅助编程新范式
本文系统阐述了AI时代开发者如何高效协作AI Coding工具,强调破除认知误区、构建个人上下文管理体系,并精准判断AI输出质量。通过实战流程与案例,助力开发者实现从编码到架构思维的跃迁,成为人机协同的“超级开发者”。
4089 106
|
9月前
|
人工智能 运维 物联网
民用卡 vs 专业卡 vs 云 GPU:大模型微调该选哪种?
本文深入解析大模型微调中民用卡、专业卡与云GPU的选型难题,从显存、算力、稳定性、成本四大维度对比三类GPU差异,结合个人、团队、企业不同场景,提供“三步选型法”与实测数据,帮你匹配最优方案,实现性能与成本的平衡。
|
10月前
|
JSON API PHP
免费天气预报API接口详解
天气预报1-7天API接口,由中国气象局官方数据支持,提供全国范围内的精准天气预报。支持查询温度、天气状况、风力风向、湿度、气压等多维度信息,具备时段预报与天气预警功能。通过RESTful API调用,返回JSON格式数据,适用于出行、农业、智能家居等多种应用场景。
6481 4

热门文章

最新文章