diff options
| -rw-r--r-- | docs/README.md | 2 | ||||
| -rw-r--r-- | docs/config.md | 4 | ||||
| -rw-r--r-- | docs/faq.md | 6 | ||||
| -rw-r--r-- | docs/themes/README.md | 2 |
4 files changed, 7 insertions, 7 deletions
diff --git a/docs/README.md b/docs/README.md index 2e8f7d9..12b0e6c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc). Here is an example: [Learn Javascript](https://www.gitbook.com/book/GitBookIO/javascript). This documentation has been generated using GitBook. -GitBook can output your content as a website ([customizable](/themes/) and [extensibles](/plugins/)) or as an ebook (PDF, ePub or Mobi). +GitBook can output your content as a website ([customizable](themes/README.md) and [extensibles](plugins/README.md)) or as an ebook (PDF, ePub or Mobi). [GitBook.com](https://www.gitbook.com) is the online platform to create and host books built using the GitBook format. It offers hosting, collaboration features and an [easy-to-use editor](https://www.gitbook.com/editor). diff --git a/docs/config.md b/docs/config.md index 2f2fd85..0b1e188 100644 --- a/docs/config.md +++ b/docs/config.md @@ -17,7 +17,7 @@ GitBook allows you to customize your book using a flexible configuration. These ### Plugins -Plugins and their configurations are specified in the `book.json`. See [the plugins section](/plugins/) for more details. +Plugins and their configurations are specified in the `book.json`. See [the plugins section](plugins/README.md) for more details. | Variable | Description | | -------- | ----------- | @@ -26,7 +26,7 @@ Plugins and their configurations are specified in the `book.json`. See [the plug ### Theme -Since version 3.0.0, GitBook can use themes. See [the theming section](/themes/) for more details. +Since version 3.0.0, GitBook can use themes. See [the theming section](themes/README.md) for more details. | Variable | Description | | -------- | ----------- | diff --git a/docs/faq.md b/docs/faq.md index b7a8b8b..57fdf3b 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -12,7 +12,7 @@ Any text editor should work! But we advise using the [GitBook Editor](https://ww #### 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. +You should always use paths and the `.md` extensions when linking to your files, GitBook will automatically replace these paths by the appropriate link when the pointing file is referenced in the Table of Contents. #### Can I create a GitBook in a sub-directory of my repository? @@ -26,8 +26,8 @@ GitBook supports math equations and TeX thanks to plugins. There are currently 2 #### Can I customize/theme the output? -Yes, both the website and ebook outputs can be customized using [themes](/themes/). +Yes, both the website and ebook outputs can be customized using [themes](themes/README.md). #### Can I add interactive content (videos, etc)? -GitBook is very [extensible](/plugins/). You can use [existing plugins](https://plugins.gitbook.com) or create your own! +GitBook is very [extensible](plugins/README.md). You can use [existing plugins](https://plugins.gitbook.com) or create your own! diff --git a/docs/themes/README.md b/docs/themes/README.md index bacde12..8a36109 100644 --- a/docs/themes/README.md +++ b/docs/themes/README.md @@ -23,4 +23,4 @@ Authors can extend the templates of a theme directly from the book source (witho ### Publish a theme -Themes are published as plugins ([see related docs](/plugins/)) with a `theme-` prefix. For example the theme `awesome` will be loaded from the `theme-awesome` plugin, and then from the `gitbook-plugin-theme-awesome` NPM package. +Themes are published as plugins ([see related docs](../plugins/README.md)) with a `theme-` prefix. For example the theme `awesome` will be loaded from the `theme-awesome` plugin, and then from the `gitbook-plugin-theme-awesome` NPM package. |