gitbook-plugin-section-numbering 是一个用于 GitBook 的插件，提供了自动为文章章节编号并展示的功能。它可以帮助书籍作者更好的组织书籍结构，使得读者更好的区分文章内容。
安装
在使用 gitbook-plugin-section-numbering 之前，需要先安装 GitBook CLI 以及 Node.js。确保系统已经安装 Node.js 后，可以在命令行中输入以下命令安装 GitBook CLI：
npm install gitbook-cli -g
安装完成后，可以在 GitBook 项目中安装 gitbook-plugin-section-numbering。
npm install gitbook-plugin-section-numbering --save-dev
配置
在书籍项目的 book.json 文件中加入以下配置：
{
"plugins": [
"section-numbering"
]
}配置完成后，运行 GitBook 即可在每一个章节标题前看到章节编号。
配置选项
gitbook-plugin-section-numbering 提供了一些选项来帮助作者更好的定制各章节编号，以下是所有可选的配置项。
版本信息
可以为书籍文档添加自定义的版本信息，支持在文章头部指定版本号以及最后一次修改时间。同时，支持在当前命令窗口中配置自动生成版本信息的默认值。
$ BOOK_VERSION=4.2.1 BOOK_GIT_COMMIT=$(git rev-parse --short HEAD) gitbook serve
-- -------------------- ---- -------
-
---------- -
-------------------
--
-------------
----------------------
-----------------------
--
--------------------
-----------
------------------
----------------------- ---------------
--
-------
------------ ------
----------------------------
-
-
-层级
默认情况下，gitbook-plugin-section-numbering 对各个一级标题进行编号。可以在配置项中更改层级。
-- -------------------- ---- -------
-
---------- -
-
------- --------------------
---------- -
---------- ----------
------------ -------
-
-
-
-章节号格式
可以使用以下占位符来构建章节号的格式。
| 占位符 | 描述 |
|---|---|
{{num}} |
当前层级内的编号。 |
{{parent.num}} |
上级层级内的编号。 |
{{title}} |
章节标题。 |
-- -------------------- ---- -------
-
---------- -
-
------- --------------------
---------- -
---------- ----------
------------ --------
--------- ----------
--------------- ------------------------
-
-
-
-自定义编号
可以为特定章节自定义编号，而非使用层级自动编号。
-- -------------------- ---- -------
-
---------- -
-
------- --------------------
---------- -
---------- ----------
------------ --------
----------------- -
---------- ---------
---------- --------
-
-
-
-
-示例
基础用法
# 一级标题 ## 二级标题 ### 三级标题
使用以上 Markdown 编写的 GitBook 文章，在启用 gitbook-plugin-section-numbering 后，通过文本渲染后可以得到以下结果。
# 1. 一级标题 ## 1.1. 二级标题 ### 1.1.1. 三级标题
自定义格式
-- -------------------- ---- -------
-
---------- -
-
------- --------------------
---------- -
---------- ----------
------------ --------
--------- ------------
--------------- ----------------- ----------
-
-
-
--- -------------------- ---- ------- - ---- -- ---- --- ---- -- ---- --- ----
通过以上 Markdown 编写的 GitBook 文章，在启用 gitbook-plugin-section-numbering 后，通过文本渲染后可以得到以下结果。
-- -------------------- ---- ------- - --- ---- -- ----- ---- --- ------- ---- -- ----- ---- --- ------- ----
总结
gitbook-plugin-section-numbering 是一个十分实用的 GitBook 插件，可以帮助作者更好的组织书籍结构，使得用户更好的区分文章内容。本文介绍了插件的安装、配置以及相关选项的使用，希望读者能够在自己的项目中使用该插件，提升文档编写效率和文章可读性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60056ea181e8991b448e76ac