• 目录结构
    • book.json
    • Summary
    • Glossary

    目录结构

    GitBook 基本的目录结构如下所示

    1. .
    2. ├── book.json
    3. ├── README.md
    4. ├── SUMMARY.md
    5. ├── chapter-1/
    6. | ├── README.md
    7. | └── something.md
    8. └── chapter-2/
    9. ├── README.md
    10. └── something.md

    这里主要讲下 GitBook 预定义的几个文件的作用

    book.json

    存放配置信息,在下一章中所讲的配置信息都是在这个文件里定义的,关于该文件的配置可以看 配置 这个章节。

    Summary

    概要文件主要存放 GitBook 的文件目录信息,左侧的目录就是根据这个文件来生成的,默认对应的文件是 SUMMARY.md,可以在 book.json 重新定义该文件的对应值。它通过 Markdown 中的列表语法来表示文件的父子关系,下面是一个简单的示例:

    1. # Summary
    2. * [Introduction](README.md)
    3. * [Part I](part1/README.md)
    4. * [Writing is nice](part1/writing.md)
    5. * [GitBook is nice](part1/gitbook.md)
    6. * [Part II](part2/README.md)
    7. * [We love feedback](part2/feedback_please.md)
    8. * [Better tools for authors](part2/better_tools.md)

    这个配置对应的目录结构如下所示:

    目录结构 - 图1

    我们通过使用 标题 或者 水平分割线 标志将 GitBook 分为几个不同的部分

    1. # Summary
    2. ### Part I
    3. * [Introduction](README.md)
    4. * [Writing is nice](part1/writing.md)
    5. * [GitBook is nice](part1/gitbook.md)
    6. ### Part II
    7. * [We love feedback](part2/feedback_please.md)
    8. * [Better tools for authors](part2/better_tools.md)
    9. ----
    10. * [Last part without title](part3/title.md)

    这个配置对应的目录结构如下所示:

    目录结构 - 图2

    Glossary

    词汇表文件,默认对应的文件是 GLOSSARY.md。该文件主要存储词汇信息,如果在其他页面中出现了该文件中的词汇,鼠标放到词汇上会给出词汇示意,可以将鼠标移到下面两个词汇上看下效果。

    Git    Markdown

    Glossary 文件的格式如下所示:

    1. ## Git
    2. 分散式版本控制软件
    3. ## Markdown
    4. Aaron Swartz John Gruber共同设计的排版语言