使用 GitBook 写文档

本贴最后更新于 1707 天前,其中的信息可能已经渤澥桑田

最近发现很多技术书籍都放在 GitBook 上提供给人们阅读,刚好 Wide 也需要写文档,索性就尝试使用 GitBook 来做。

GitBook 简介

GitBook 是一个通过 Git 和 Markdown 来撰写书籍的工具,最终可以生成 3 种格式:

GitBook 是免费且开源的,项目地址:https://github.com/GitbookIO/gitbook

Git 方式

GitBook 使用 Git 进行写作内容管理。

正所谓:“人法地,地法天,天法道,道法自然”啊。

Markdown

GitBook 不只是利用了 Git,目前非常流行的 Markdown 也被运用其中。

使用 Markdown 最大的好处就是简单:

总之,Markdown 就是能够让写作者更专注于内容创作。

不过 GitBook 不只是简单地使用 Markdown,使用 Markdown 编写的内容只是源格式,最终的目标格式可以为 PDF、ePub 等。

静态站点

在本地编写完内容后我们需要将内容提交到 GitBook 上进行书籍的构建。GitBook 会将书籍构建为 4 种格式(JSON、ePub、PDF、Website)。 其中我们最常用的应该是静态站点,这样能够方便传播。

客户端编辑器

可以使用 GitBook 的官方编辑器来进行写作、发布等管理,非常方便:

GitBook Editor

其他

GitBook 还有很多功能,例如:

题外话

GitHub、GitBook、GitXXX 都很流行啊,为什么呢?

Git 已经不只是一个版本控制系统了,它的分布式协作方式正在潜移默化地影响着很多程序的设计,最终影响了很多在线服务的提供方式。这样一种私有-公有可控的网络信息架构是非常值得我们学习并实践的,这样架构的各类产品将越来越多。

赞助商 我要投放

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • eddy

    拜读完! 人发地,地法天,天法道,道法自然 这个是亮点

  • someone

    就会弄点 VIM,再也不折腾了哈。好吧其实我是来串门的,求回访。

  • someone

    赞一个

  • someone

    好是好,但是好像缺失了markdown的流程图模块,只能用于一些很简单的文章内容书写

  • someone

    您好,我想问下GitBook可以配置自己的二级域名吗?
    如果可以的话,希望可以提供文章或者思路。
    非常感谢

  • someone

    要代理翻墙,一点不好使

请输入回帖内容 ...