⭐⭐⭐ Spring Boot 项目实战 ⭐⭐⭐ Spring Cloud 项目实战
《Dubbo 实现原理与源码解析 —— 精品合集》 《Netty 实现原理与源码解析 —— 精品合集》
《Spring 实现原理与源码解析 —— 精品合集》 《MyBatis 实现原理与源码解析 —— 精品合集》
《Spring MVC 实现原理与源码解析 —— 精品合集》 《数据库实体设计合集》
《Spring Boot 实现原理与源码解析 —— 精品合集》 《Java 面试题 + Java 学习指南》

摘要: 原创出处 码问 「青苗」欢迎转载,保留摘要,谢谢!


🙂🙂🙂关注微信公众号:【芋道源码】有福利:

  1. RocketMQ / MyCAT / Sharding-JDBC 所有源码分析文章列表
  2. RocketMQ / MyCAT / Sharding-JDBC 中文注释源码 GitHub 地址
  3. 您对于源码的疑问每条留言都将得到认真回复。甚至不知道如何读源码也可以请教噢。
  4. 新的源码解析文章实时收到通知。每周更新一篇左右。
  5. 认真的源码交流微信群。

写技术文档这件事,说实话挺头疼的。内容要准确,排版要好看,还得方便读者查阅。今天给大家安利一个神器——mdBook,一个用 Rust 写的命令行工具,专门用来把 Markdown 变成漂亮的在线书籍。

https://github.com/rust-lang/mdBook

不管你是写产品文档、API 文档还是教程,用它都特别顺手。下面说说为啥我觉得它好用。

mdBook 的几个亮点

1. Markdown 写作,上手零门槛

会 Markdown 就会用 mdBook,就这么简单。# 打标题,[]() 加链接,列表、引用、代码块啥都支持。基本上你平时怎么写 Markdown,这里就怎么写,没有额外的学习成本。

2. 想怎么定制就怎么定制

通过 book.toml 配置文件,标题、作者、主题颜色、字体这些都能改。官方还提供了好几套模板,不满意的话自己做一套也行。反正就是怎么好看怎么来。

3. 功能比你想的多

除了基础的 Markdown 语法,它还支持 LaTeX 数学公式、自定义 CSS、内联 SVG 这些高级玩法。更厉害的是内置了测试框架,可以给每个章节加测试,保证文档里的代码示例是能跑的。写教程的同学应该懂这有多重要。

4. 一份内容,多种格式

写完直接导出 HTML、PDF、EPUB,想要啥格式有啥格式。还能一键部署到 GitHub Pages,分享起来特别方便。

文章目录
  1. 1. mdBook 的几个亮点