gitbook(三) 书写规则 - pengkang的博客

gitbook(三) 书写规则

gitbook-readme

1、目录结构

上一篇文章中说到,gitbook里面有两个文件,这两个文件是电子书的整体介绍,包括目录和概括,

  1. SUMMARY.md 用来存放显示目录
  2. README.md 用来介绍电子书概括信息

2、创建文章

SUMMARY.md文件是非常重要的,文章的目录管理和文章的索引都是在这个里进行保存的,后续每次创建新的文章,都需要在这个文件内容里面编辑相对应的内容,先来看下文件的具体内容

summary

  • Summary 电子书的标题,书的名称
  • Introduction 文章的标题
  • README.md 文章的存放路径,因为文件编译后,都是文章都是放在同级目录,只需要引用文件名称,当目录结构比较复杂的时候,引用相对路径

在根目录下创建一个 hello.md 文件,然后在 SUMMARY文件 中添加如下内容
hello

然后在执行命令,进行编译和部署

1
$ gitbook serve

部署完成后,根据控制台的提示,进行访问,即可展示下面的内容
hello

3、语法介绍

Markdown是一种文本标记语言,用于快速文档排版。通过简单的标记,可以使普通文本内容具有一定的格式

gitbook是支持markdown,所以在写文章之前需要先了解markdown的基本语法,我在这里列出常用的语法,具体的可以出门右转找百度

1、标题

使用 # 号可表示 1-6 级标题,一级标题对应一个 # 号,二级标题对应两个 # 号,以此类推。。标准语法一般在#后跟个空格再写文字,如下图所示:

title

2、段落

Markdown 段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车

段落
段落

3、字体

Markdown 可以使用以下几种字体,都是用一些简单符号包裹起来:

  1. **加粗**

加粗

  1. *斜体文本*

斜体文本

  1. ***粗斜体文本***

粗斜体文本

  1. ~~删除线文本~~

    ~~删除线文本~~

4、链接

链接的方式有很多,文字,图片,视频,外部引用

1.文字

[文字](www.baidu.com)

文字

2.图片

![图片](/images/post-img/gitbook/beautiful.jpg)

图片

3.视频

视频的话,比较特殊,需要有视频源,我一般都是在blili或者YouTube上查找,直接将路径复制到文件中

还可以使用 HTML 的语法,在文件中插入,具体操作方式可以百度

iframe src="//player.bilibili.com/player.html?aid=55879448&cid=97666871&page=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true">

如果这篇文章对您很有帮助,不妨
-------------    本文结束  感谢您的阅读    -------------
0%