{"id":19501159,"url":"https://github.com/gitbookio/theme-faq","last_synced_at":"2026-07-23T22:30:15.037Z","repository":{"id":73453681,"uuid":"56139765","full_name":"GitbookIO/theme-faq","owner":"GitbookIO","description":"Theme for publishing a FAQ or Knowledge base","archived":false,"fork":false,"pushed_at":"2018-10-04T15:19:21.000Z","size":34,"stargazers_count":38,"open_issues_count":10,"forks_count":25,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-01-08T10:14:23.502Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GitbookIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-13T09:43:03.000Z","updated_at":"2023-09-08T17:09:11.000Z","dependencies_parsed_at":"2023-02-28T13:01:49.064Z","dependency_job_id":null,"html_url":"https://github.com/GitbookIO/theme-faq","commit_stats":{"total_commits":48,"total_committers":7,"mean_commits":6.857142857142857,"dds":"0.41666666666666663","last_synced_commit":"e0f04d8bfddcbcdc4de09e5354570bb1cef098a7"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Ftheme-faq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Ftheme-faq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Ftheme-faq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Ftheme-faq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GitbookIO","download_url":"https://codeload.github.com/GitbookIO/theme-faq/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240748865,"owners_count":19851358,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T22:11:38.837Z","updated_at":"2026-07-23T22:30:14.935Z","avatar_url":"https://github.com/GitbookIO.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitBook FAQ Theme\n\nTheme for using GitBook to publish an FAQ or Knowledge Base. This theme works perfectly with search plugins (as the [default one](https://github.com/GitbookIO/plugin-search) or [algolia](https://github.com/GitbookIO/plugin-algolia)).\n\n## Usage\n\nThis theme requires GitBook version 3 or later.\n\nAdd the theme to your book's configuration (`book.json`):\n\n```js\n{\n    \"plugins\": [\n        \"theme-faq\",\n        \"-fontsettings\",\n        \"-sharing\"\n    ]\n}\n```\n\n**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).\n\n### Add relations between articles\n\nSuggestions for other articles can be shown at the bottom of an article.\n\nRelationships are specified in the YAML frontmatter of a page:\n\n```md\n---\nrelated:\n    - some/other/page.md\n    - another_related_article.md\n\n---\n\nContent of my article!\n```\n\n### Add logo to header\n\nExtend the theme by creating a file `_layouts/website/page.html` in your book with:\n\n```html\n{% extends template.self %}\n\n{% block faq_header_brand %}\n\u003cimg src=\"https://mywebsite.com/logo.png\" height=\"30\" /\u003e\n{% endblock %}\n```\n\n### Add navigation links to the header\n\nExtend the theme by creating a file `_layouts/website/page.html` in your book with:\n\n```html\n{% extends template.self %}\n\n{% block faq_menu %}\n\u003cul class=\"nav navbar-nav navbar-right\"\u003e\n    \u003cli\u003e\u003ca href=\"#\"\u003eContact us\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#\"\u003eReturn to SuperWebsite\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n{% endblock %}\n```\n\n### Add a short description on the home page\n\nThe content of your `README` is used as a short description for the home page of your FAQ.\n\nIf you wish use a specific file for this description instead of your project's README, you can configure your `book.json` to do so:\n\n```json\n{\n  \"structure\": {\n     \"readme\": \"home-page-description.md\"\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbookio%2Ftheme-faq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitbookio%2Ftheme-faq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbookio%2Ftheme-faq/lists"}