Gitbook是个什么东西,有什么优点,如何使用,这篇文章将向大家详细介绍

Gitbook是什么

gitbook是一个github上的开源项目,主旨是为了可以让所有人快速地建立文档,Gitbook是使用Git和Markdown来开发文档的,用Git的好处就是敏捷高效地处理文档,而Markdown是现在大多数程序猿喜欢的一种开发语言,通过极其简单的语法来让普通的文本内容也有一定的格式。

Gitbook有什么优点

先上一个gitbook给大家看一下:Docker —— 从入门到实践

你会发现,Gitbook的优势就是整体风格简洁美观(有多种主题可供选择)、目录清晰、让人有阅读的欲望,而且最重要的就是回归阅读的本质,去除了以往文档的“杂质”,这也是为什么我想把Gitbook推荐给大家。

Gitbook的使用

说了这么多,接下来就可以介绍怎么使用Gitbook了,建立Gitbook有两种方法,在这里我简单将用户群体分为程序猿和非程序猿两种,尽量以通俗易懂的方式来和大家说明用法

一、非程序猿

  1. 登陆Gitbook首页: https://www.gitbook.com/
  2. 右上角Signin登陆:
  3. 注册一个账号或者用其他社交账号登陆
  4. 新建Gitbook:
  5. 填写gitbook相关信息,上面那一栏是Gitbook的类别,前两者是 基本类科学类 ,后三者是程序猿专用,可以和github相关联, Title 填文档的标题,下面那一行填写的你gitbook的地址(以后别人访问你的文档的地址), Description 填写文档的描述, PublicPrivate 就是你的文档是希望公开的,还是希望是私人的,公开就是任何人都能访问,私人就是你需要登陆网站之后才能查看
  6. 初始化好你的Gitbook后,看到如下界面就可以开始编辑你的文档了,点击 Edit your book 即可
  7. 点击后,我们就来到了最重要的编辑页面了,先上个图,我们可以看到界面非常简洁,可是麻雀虽小五脏俱全,这里就详细介绍怎么写出美美的文档

    1. 首先是介绍顶部左侧的编辑按钮,依次是 返回 Gitbook信息页 、保存、回退、前进、加粗、斜体、中划线、标题1、标题2、标题3、无序列表、有序列表、引用、表格、分隔线、链接、图片、代码、公式 、索引,加粗的是大家常用的

    2. 然后是右侧相关按钮,从左到右依次是校对(非中文)、是否显示左侧面板、显示文档预览效果、文档其他分支(非程序员可以不理)、编辑历史、设置
    3. 然后介绍设置面板,具体里面的选项大家直接看英文翻译吧,这里就不详细说明了,从左到右分别是编辑界面相关设置、校队相关设置、显示相关设置、 快捷键相关设置 (很有用,建议看一下) 、 目录相关设置 (这个也要注意一下,默认设置是删除了目录中的选项,就会默认删除对应的文档,所以大家可以根据选择来选择是否 )
    4. 下面来到初学者有点难理解的地方了,Gitbook的文档核心就是Summary.md文件,在左侧的 Files Tree 那里就可以看到文件,这个文件其实就是文档的目录文件,这个目录在编辑过程中你其实是不用去管的,得益于在线编辑器的方便,它是自动生成的,而自动生成的依据,就是上面的Table of Content,我们举个下面的例子,比如我要建一个这样的目录,是怎么建立起来的呢?其实很简单,首先我们一定要注意一个文档的原则: 目录最好对应相关联的文档文件 在Table of Contents那里直接点击右键,会出现下图弹出层,在哪个目录点击右键 New Article 就是在当前目录下新建子目录, Rename 就是重命名当前目录, Edit Pointing File 就是编辑目录对应的文件(什么意思请理解我刚才说的文档的原则) 点击New Article会弹出对话框让你填写目录名,建立后Table of Contents就会出现你建好的目录,然后点击目录之后会提示让你建了一个文件对应这个目录(可以不需要,可是原则上是必须的),建好的目录也可以随时删除,建好所有目录后,你会发现Summary也随之改变了,多方便
  8. 建立相关目录后就可以开始编写你的文档了,直接看效果的话也可以在顶部面板设置,编辑之后你想看效果,可以回到 Gitbook信息页 ,有一个大大的 Read ,你就可以看到刚才建好的文档的 效果 了(PC和手机都可以看哦),当然,你也可以 生成pdf/ePub/Mobi格式的电子书
  9. 好吧,开始开心的撰写文档吧!

二、程序猿

Gitbook安装

  1. 安装nodejs: https://nodejs.org/
  2. 安装Git: http://git-scm.com/download/ (如果需要你的文档同步到Github上的话)
  3. 命令行:

    | 1 | $npminstallgitbook-cli-g | | :--- | :--- |

Gitbook 命令

  1. gitbook init 根据目录中的SUMMARY.md来生成对应的目录

    SUMMARY.md相当于文档整个的脉络,也就是目录,init命令会根据你在SUMMARY.md撰写的相关目录和文件名来直接创建文件

  2. gitbook build 生成文档文件,生成目录是本目录下的 _book

    根据文档文件生成对应的html最终文件

  3. gitbook serve 生成文档文件,并启动服务

    可以实时监控文档文件变化,并生成最新的文档文件,适合在撰写过程中观看文档变化

Gitbook 撰写

语法是Markdown语法,可以直接看svn上的文档源文件学习,对我们来说是零难度的,是现在最流行的语法之一

http://www.jianshu.com/p/1e402922ee32/

文档的制作其实就是MarkDown文件转成HTML,Markdown是兼容Html,也就是在Markdown文件中写html代码也是没问题的,所以对我们前端来说是零难度,语法方面就参考上面的地址就行,或者直接通过svn上的源文件学习即可,几分钟就可以上手

自定义样式

css文件在styles/website.css中,可以自行添加相关样式,其他自定义方法可以在官方文档中查看

results matching ""

    No results matching ""