diff options
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | book.js | 14 | ||||
| -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 |
6 files changed, 33 insertions, 16 deletions
@@ -27,6 +27,9 @@ node_modules # vim swapfile *.swp +# Output of documentation +docs/_book + lib2 test2 theme2
\ No newline at end of file diff --git a/book.js b/book.js deleted file mode 100644 index 773256a..0000000 --- a/book.js +++ /dev/null @@ -1,14 +0,0 @@ -var pkg = require('./package.json'); - -module.exports = { - root: './docs', - plugins: ['versions'], - pluginsConfig: { - versions: { - type: 'tags' - } - }, - variables: { - version: pkg.version - } -}; 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 |