diff options
Diffstat (limited to 'docs/faq.md')
| -rw-r--r-- | docs/faq.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..42de8fe --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,33 @@ +# 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. + +#### Can I create a GitBook in a sub-directory of my repository? + +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! |