1. 簡單介紹
本章來介紹一下 Gitbook
的目錄結構,下面的目錄結構表示了一個簡單的 Gitbook 的目錄結構。
.
├── book.json
├── README.md
├── SUMMARY.md
├── GLOSSARY.md
├── chapter-1/
| ├── README.md
| └── something.md
└── chapter-2/
├── README.md
└── something.md
GitBook 目錄文件的主要功能:
文件名 | 描述 |
---|---|
book.json | 配置數據 (可選) |
README.md | 電子書的前言或簡介 (必需) |
SUMMARY.md | 電子書目錄 (可選) |
GLOSSARY.md | 詞匯/注釋術語列表 (可選) |
2. 菜單結構
SUMMARY.md
文件描述了書籍的菜單結構。
[]
指定菜單項目的標題()
指定菜單文章文件的路徑- 支持子目錄的方式,章節和子章節用
兩個
、四個空格
或者tab
鍵來分級 #
或者---
進行不同Part
的分類,分別由標題或者水平分割線方式表示不同的部分- 區域導航定位,在章節
路徑 md
文件結尾使用#
號加上文章內容中章節的標題就能實現區域導航
# Summary
### Part I
* [Part I](part1/README.md)
* [Writing is nice](part1/README.md#writing)
* [GitBook is nice](part1/README.md#gitbook)
### Part II
* [Part II](part2/README.md)
* [We love feedback](part2/README.md#feedback)
* [Better tools for authors](part2/README.md#tools)
----
* [Last part without title](part3/title.md)
3. 頁面文件
Gitbook
書籍的頁面文件采用 Markdown
的語法實現,電子書的第一頁內容是從文件 README.md
中提取的。如果這個文件名沒有出現在 SUMMARY
中,那么它會被添加為章節的第一個條目。對 Markdown 語法不熟悉的可以參考:菜鳥教程、MarkDown中文網 或者其他參考的網站。
參考示例:
# Title of the chapter
This is a great introduction.
## Section 1
Markdown will dictates _most_ of your **book's structure**
## Section 2
...
頁面頂部描述
它使用 YAML 格式的風格來定義文檔的描述信息,在三條虛線之間
,文檔中也可以不寫頂部描述,這個不是必須的。
參考示例:
---
description: This is a short description of my page
---
# The content of my page
...
4. 專業術語列表
在 Gitbook 中使用 GLOSSARY.md
來進行專業術語列表的配置
。將一些專業名詞,名詞或者術語的解釋配置定義在文件中,在書籍中使用到對應專業術語的地方就可以鏈接到專業解釋的地方。
定義的方式是在 GLOSSARY.md 使用 ##
列表來定義專業術語的列表。
參考示例:
## markdown
Markdown是一種輕量級標記語言,創始人為約翰·格魯伯(英語:John Gruber)。
它允許人們使用易讀易寫的純文本格式編寫文檔,然后轉換成有效的XHTML(或者HTML)文檔。
這種語言吸收了很多在電子郵件中已有的純文本標記的特性。
## gitbook
GitBook 是一個基於 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 來制作精美的電子書。
## Term
Definition for this term
## Another term
With it's definition, this can contain bold text
and all other kinds of inline markup ...
5. 忽略文件
在 SUMMARY.md
中未列出的文件。所有靜態文件,包含圖片、JS、CSS都會復制到對應目錄下,對於一些不需要的文件,GitBook將讀取 .gitignore
、.bookignore
和 .ignore
文件,以獲取要忽略的文件和文件夾的列表。被忽略的文件不會被上傳到版本中。這些文件的語法和 Git
中的 gitignore 語法相同。
參考示例:
# This is a comment
# Ignore the file test.md
test.md
# Ignore everything in the directory "bin"
bin/*
6. 以子目錄的方式與項目集成
對於 Gitbook 書籍項目,可以使用子目錄
(如example-docs/)來存儲項目的文檔。您可以在 book.json
中通過配置選項告訴 GitBook
在那里找到根目錄
注意:
book.json
文件除外, book.json 文件所在位置代表的就是項目的根目錄,但是可以將書籍項目的其他文件放置在子目錄。
參考示例:
1. 項目目錄結構:
.
├── book.json
└── example-docs/
├── README.md
└── SUMMARY.md
2. book.json 中的配置:
{
"root": "./example-docs"
}
7. 總結
本章介紹了 Gitbook
中的基本目錄的結構和對應的用處。熟悉后可以對 Gitbook 的體系結構更加熟悉,同時也能更好的去書寫你的書籍了。
參考:官網介紹
>>> 系列文章快捷導航: