Theme for publishing a FAQ or Knowledge base
Clone or download
Latest commit e0f04d8 Jan 19, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_i18n Cleanup layout Apr 18, 2016
_layouts/website Update Bootstrap to be compatible with jQuery version Jan 19, 2017
src/less Fixes overflow of the description on small screens. (#15) Jan 19, 2017
.gitignore Initial commit Apr 13, 2016
.npmignore Initial commit Apr 13, 2016
README.md Fix typo (#17) Jan 19, 2017
package.json Bump version to 1.2.1 Jan 19, 2017

README.md

GitBook FAQ Theme

Theme for using GitBook to publish an FAQ or Knowledge Base. This theme works perfectly with search plugins (as the default one or algolia).

Usage

This theme requires GitBook version 3 or later.

Add the theme to your book's configuration (book.json):

{
    "plugins": [
        "theme-faq",
        "-fontsettings",
        "-sharing"
    ]
}

NOTE theme-faq is not compatible with plugins that modify the toolbar (since there is no toolbar). Embedded search will not work as a result. This includes the default plugins fontsettings and sharing that need to be disabled explicitly (add a minus flag "-" before each plugin parameter).

Add relations between articles

Suggestions for other articles can be shown at the bottom of an article.

Relationships are specified in the YAML frontmatter of a page:

---
related:
    - some/other/page.md
    - another_related_article.md

---

Content of my article!

Add logo to header

Extend the theme by creating a file _layouts/website/page.html in your book with:

{% extends template.self %}

{% block faq_header_brand %}
<img src="https://mywebsite.com/logo.png" height="30" />
{% endblock %}

Add navigation links to the header

Extend the theme by creating a file _layouts/website/page.html in your book with:

{% extends template.self %}

{% block faq_menu %}
<ul class="nav navbar-nav navbar-right">
    <li><a href="#">Contact us</a></li>
    <li><a href="#">Return to SuperWebsite</a></li>
</ul>
{% endblock %}

Add a short description on the home page

The content of your README is used as a short description for the home page of your FAQ.

If you wish use a specific file for this description instead of your project's README, you can configure your book.json to do so:

{
  "structure": {
     "readme": "home-page-description.md"
  }
}