手把手教你GitBook使用(二)

简介: 详细的记录了一步步搭建自己的电子文档笔记

3. 详细说明


3.1 编写 README and SUMMARY

此文件为章节目录设置文件,如果我们想为我们的创作添加章节目录,我们可以利用 Sumary.md 文件进行章节目录划分,此文件的书写格式也比较简单,例如:


3.1.1 README.md

这个文件相对于是一本 Gitbook 的简介,比如我们这本书的 README.md :

1.png

3.1.2 SUMMARY.md


这个文件相对于是一本书的目录结构。比如我们这本书的 SUMMARY.md :

2.png

SUMMARY.md 基本上是列表加链接的语法。链接中可以使用目录,也可以使用。


3.2 本地预览


3.2.1 gitbook init

在预览之前,还需要做一步操作。

当 README.md、SUMMARY.md 创建完毕之后,我们可以使用 Gitbook 的命令行工具将这个目目录结构生成相应地目录及文件

3.png

我们可以看到,gitbook 给我们生成了与 SUMMARY.md 所对应的目录及文件。

每个目录中,都有一个 README.md 文件,用于描述这一章的说明。


3.2.2 gitbook serve


接下来,我们使用

4.png

我的操作,启动服务,进行预览:

5.png启动完之后,浏览器输入:http://localhost:4000

注意:

可以事先创建好文章目录,通过执行 gitbook init 自动生成对应的文件,然后在 gitbook serve。






目录
相关文章
|
JavaScript 开发工具 git
GitBook新手入门
GitBook是使用Git管理书籍项目,使用Markdown撰写书籍,并使用GitHub和GitBook网站进行托管的一个实用工具。下面简单说一下新手如何使用该强大的工具。
156 0
|
Python Windows
Python安装教程-手把手教你安装
Python安装教程-手把手教你安装
Python安装教程-手把手教你安装
|
JavaScript
Hexo 入门指南(七) - 评论 & 分享
Hexo 入门指南(七) - 评论 & 分享
83 0
|
JavaScript Ubuntu
gitbook 快速入门
gitbook 快速入门
gitbook 快速入门
|
存储 JavaScript 前端开发
grunt入门笔记
grunt在前端工具中算是很有用的一个工具。 想一想如果没有这个工具,我们需要手动新建一个压缩代码后的文件夹,每次修改原始文件,都要手动压缩一下,再保存到压缩后的文件夹,想想都要疯掉。所以,grunt前端必不可少。
133 0
grunt入门笔记
Hexo、Jekyll、Sphinx、mkdocs、docsify等静态博文档汇总
Hexo、Jekyll、Sphinx、mkdocs、docsify等静态博文档汇总
268 0
Hexo、Jekyll、Sphinx、mkdocs、docsify等静态博文档汇总
|
机器人
gitbook 插件 阅读更多
gitbook 插件 阅读更多
|
开发工具 git
gitbook docs 序言
gitbook docs 序言
|
JavaScript 开发者 SEO
vuepress入门教程
vuepress入门教程
1504 0