diff options
author | Samy Pesse <samypesse@gmail.com> | 2016-02-24 22:42:11 +0100 |
---|---|---|
committer | Samy Pesse <samypesse@gmail.com> | 2016-02-24 22:42:11 +0100 |
commit | d7d0429169ea097dcd51d9622036390433410944 (patch) | |
tree | 3fff6da3e0bf55eda5c7457e2ef1afb1afca89f7 /docs | |
parent | 4bf5dc6646f6f14ce734695f3a3ca007813bc99a (diff) | |
download | gitbook-d7d0429169ea097dcd51d9622036390433410944.zip gitbook-d7d0429169ea097dcd51d9622036390433410944.tar.gz gitbook-d7d0429169ea097dcd51d9622036390433410944.tar.bz2 |
Add doc section about summary
Diffstat (limited to 'docs')
-rw-r--r-- | docs/SUMMARY.md | 1 | ||||
-rw-r--r-- | docs/faq.md | 6 | ||||
-rw-r--r-- | docs/pages.md | 36 | ||||
-rw-r--r-- | docs/themes.md | 2 |
4 files changed, 42 insertions, 3 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index d8c436b..dd48c67 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -18,7 +18,6 @@ * [Templating](templating.md) * [Content References](conrefs.md) * [Variables](variables.md) - * [Filters](filters.md) ### Customization diff --git a/docs/faq.md b/docs/faq.md index f960409..db6ac07 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -6,4 +6,8 @@ You should always use `.md` extensions for your relative links, GitBook will aut #### Can I create a GitBook in a sub-directory of my repository? -Yes, GitBooks can be created in sub-directories. GitBook.com and the CLI also looks by default in a series of [folders](structure.md).
\ No newline at end of file +Yes, GitBooks can be created in sub-directories. GitBook.com and the CLI also looks by default in a series of [folders](structure.md). + +#### Does GitBook support Math equations? + +GitBook supports math equations and TeX thanks to plugins. There are currently 2 official plugins to display math: [mathjax](https://plugins.gitbook.com/plugin/mathjax) and [katex](https://plugins.gitbook.com/plugin/katex). diff --git a/docs/pages.md b/docs/pages.md new file mode 100644 index 0000000..e72ffad --- /dev/null +++ b/docs/pages.md @@ -0,0 +1,36 @@ +# Pages and Summary + +GitBook uses a `SUMMARY.md` file to define the structure of chapters and subchapters of the book. The `SUMMARY.md` file is used to generate the book's table of contents. + +The `SUMMARY.md`'s format is simply a list of links, the title of the link is used as the chapter's title, and the target is a path to that chapter's file. + +Subchapters are defined simply by adding a nested list to a parent chapter. + +### Simple example + +``` +# Summary + +* [Part I](part1/README.md) + * [Writing is nice](part1/writing.md) + * [GitBook is nice](part1/gitbook.md) +* [Part II](part2/README.md) + * [We love feedback](part2/feedback_please.md) + * [Better tools for authors](part2/better_tools.md) +``` + +### Example with subchapters split into parts + +``` +# Summary + +### Part 1 + +* [Writing is nice](part1/writing.md) +* [GitBook is nice](part1/gitbook.md) + +### Part 2 + +* [We love feedback](part2/feedback_please.md) +* [Better tools for authors](part2/better_tools.md) +``` diff --git a/docs/themes.md b/docs/themes.md index d92f0ac..48c19db 100644 --- a/docs/themes.md +++ b/docs/themes.md @@ -1,6 +1,6 @@ # Theming -Since version 3.0.0, GitBook can be easily themed. Books are using by default the [gitbook-theme-default](https://github.com/GitbookIO/gitbook-theme-default). +Since version 3.0.0, GitBook can be easily themed. Books are using by default the [theme-default](https://github.com/GitbookIO/theme-default). The theme to use is specified in the [book's configuration](config.md) using key `theme`. |