diff options
| author | Samy Pessé <samypesse@gmail.com> | 2016-02-25 11:59:45 +0100 |
|---|---|---|
| committer | Samy Pessé <samypesse@gmail.com> | 2016-02-25 11:59:45 +0100 |
| commit | 08754bc6266a8a23b4382963ef765a231ee5ed14 (patch) | |
| tree | e675d4bbbed2c4f382b2c24311f833a2f766d53d /docs | |
| parent | 702542f4080437270d99b7494981bb2719d73fba (diff) | |
| download | gitbook-08754bc6266a8a23b4382963ef765a231ee5ed14.zip gitbook-08754bc6266a8a23b4382963ef765a231ee5ed14.tar.gz gitbook-08754bc6266a8a23b4382963ef765a231ee5ed14.tar.bz2 | |
Improve the faq
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/faq.md | 20 | ||||
| -rw-r--r-- | docs/variables.md | 1 |
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/faq.md b/docs/faq.md index ed908b2..42de8fe 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,15 @@ # GitBook FAQ +#### How can I host/publish my book? + +Books can easily be published and hosted on [GitBook.com](https://www.gitbook.com). But GitBook output can be hosted on any static file hosting solution. + +#### What can I use to edit my content? + +Any text editor should work! But we advise using the [GitBook Editor](https://www.gitbook.com/editor). [GitBook.com](https://www.gitbook.com) also provides a web version of this editor. + +--- + #### Should I use an `.html` or `.md` extensions in my links? You should always use `.md` extensions for your relative links, GitBook will automatically replace these links by the right value when the pointing file is referenced in the Table of Contents. @@ -8,6 +18,16 @@ You should always use `.md` extensions for your relative links, GitBook will aut Yes, GitBooks can be created in [sub-directories](structure.md#subdirectory). GitBook.com and the CLI also looks by default in a serie 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). + +#### Can I customize/theme the output? + +Yes, both the website and ebook outputs can be customized using [themes](themes.md). + +#### Can I add interactive content (videos, etc)? + +GitBook is very [extensible](plugins.md). You can use [existing plugins](https://plugins.gitbook.com) or create your own! diff --git a/docs/variables.md b/docs/variables.md index 879c646..3dbd6f7 100644 --- a/docs/variables.md +++ b/docs/variables.md @@ -19,6 +19,7 @@ The following is a reference of the available data during book's parsing and the | Variable | Description | | -------- | ----------- | | `book.[CONFIGURATION_DATA]` | All the `variables` set via the `book.json` are available through the book variable. | +| `book.language` | Current language for a multilingual book | ### GitBook Variables |