diff options
author | Samy Pessé <samypesse@gmail.com> | 2016-02-21 01:02:38 +0100 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2016-02-21 01:02:38 +0100 |
commit | e16b3e35f438014cb51fac84a500c8996d18658d (patch) | |
tree | a62f9cb30ac4fbf24da700089ae58a1b942e9678 /docs | |
parent | 2f15e26ffa9ca67007e9f23ac732fed0fcb109d9 (diff) | |
download | gitbook-e16b3e35f438014cb51fac84a500c8996d18658d.zip gitbook-e16b3e35f438014cb51fac84a500c8996d18658d.tar.gz gitbook-e16b3e35f438014cb51fac84a500c8996d18658d.tar.bz2 |
Setup summary for documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/README.md | 2 | ||||
-rw-r--r-- | docs/SUMMARY.md | 19 | ||||
-rw-r--r-- | docs/book.js | 11 | ||||
-rw-r--r-- | docs/plugins.md | 0 |
4 files changed, 30 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md index 2dfffba..8329a5c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# GitBook v{{ book.version }}: Documentation +# GitBook Documentation: v{{ book.version }} ### FAQ diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 58d6763..a4f2a98 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,13 +1,30 @@ # Summary +### Getting Started + * [About this document](README.md) +* [Installation and Setup](setup.md) +* [Directory structure](structure.md) + +### Your Content + * [Configuration](config.md) * [Pages and Summary](pages.md) * [Assets](assets.md) * [Glossary](glossary.md) + +### Miscellaneous + * [Templating](templating.md) * [Content References](conrefs.md) * [Variables](variables.md) * [Filters](filters.md) + +### Customization + * [Plugins](plugins.md) -* [Theming](themes.md)
\ No newline at end of file +* [Theming](themes.md) + +-- + +* [FAQ](faq.md) diff --git a/docs/book.js b/docs/book.js new file mode 100644 index 0000000..b04e91c --- /dev/null +++ b/docs/book.js @@ -0,0 +1,11 @@ +var pkg = require('../package.json'); + +module.exports = { + "title": "GitBook Documentation", + + plugins: ["theme-official"], + theme: "official", + variables: { + version: pkg.version + } +}; diff --git a/docs/plugins.md b/docs/plugins.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/plugins.md |