All the options available for site appearance and functionalities are shown in the next table. These options are available in _config.yml or in the configuration files and will allow personalisation of the documentation site. Personalisation means that the appearance and functionalities of the site can be modified from the configuration files.
The config files may contain a lot more sections/keys/values additionally to the ones shown in the next table. If a key from a file is not shown in the next table, it means that it must not be changed because is not a configuration option. Changing other keys/values except for the ones listed on this page may cause site build fail or unexpected behavior/appearance of the site.
Note
The site must be built and deployed (where applicable) in order to make new config options to be visible. If the site runs in dev mode, it has to be stopped and served again (using serve script).
Show
| No. | Option | Category | Description | File | Key |
|---|---|---|---|---|---|
| 1 | Site title | Appearance | The title of the site as it is shown in the left-upper corner | _config.yml | title |
| 2 | Aux buttons in site header | Appearance | Link buttons to be added in the right-upper corner of the site header | _config.yml | aux_links |
| 3 | Aux link buttons open in new tab | Appearance | Links targeted by the aux buttons are open in a new tab | _config.yml | aux_links_new_tab |
| 4 | Collections | Documents | Define your custom collections (Jekyll style) | _config.yml | collections |
| 5 | Collections settings | Documents | Assign friendly names to colections and set folding behaviour | _config.yml | just_the_docs/collections |
| 6 | Light theme text color | Appearance | Content text color for light theme | siteConfig.yml | colSchemaCorrections/textColorOnElementsAffected/light |
| 7 | Light theme background color | Appearance | Background for the light theme | siteConfig.yml | colSchemaCorrections/backgroundColorOnElementsAffected/light |
| 8 | Dark theme text color | Appearance | Content text color for dark theme | siteConfig.yml | colSchemaCorrections/textColorOnElementsAffected/dark |
| 9 | Dark theme background color | Appearance | Background for dark theme | siteConfig.yml | colSchemaCorrections/backgroundColorOnElementsAffected/dark |
| 10 | Site logo | Appearance | Set the site logo image by pointing to an immage inside assets/img directory | siteConfig.yml | layouts/headerArea/siteLogo |
| 11 | Site categories in site menu | General Feature | Show or hide categories in site menu | siteConfig.yml | catMenu |
| 12 | No. of similar pages | Auto similar docs | Set how many similar by content pages are shown (based on similarity score) | siteConfig.yml | similarByContent/maxPages |
| 13 | Prev/Next navigation | General Feature | Activate/Deactivate prev/next navigation on each content page | siteConfig.yml | navPrevNextEnabled |
| 14 | HubSpot integration | Integrations | Enable/Disable HubSpot forms integration | siteConfig.yml | hsIntegration/enabled |
| 15 | HubSpot form submissions source | Integrations | Set the source for HubSpot form submissions | siteConfig.yml | hsIntegration/forms/submisionSource/propValue |
| 16 | Privacy link | General Feature | Link yo your privacy policy | siteConfig.yml | links/privacyLink |
| 17 | Support link | General Feature | Link to your technical support page | siteConfig.yml | links/supportLink |
| 18 | Content selected text menu | General Feature | Enable/Disable contect menu on content text (to not be used without Algolia docSearch) | siteConfig.yml | selectedTextContextMenu/enabled |
| 19 | Selected text menu min. words | General Feature | Minimum words selected to open the selected text menu | siteConfig.yml | selectedTextContextMenu/minWords |
| 20 | Selected text menu max. words | General Feature | Maximum words selected to allow open the selected text menu | siteConfig.yml | selectedTextContextMenu/maxWords |
| 21 | Text annotations | Taxonomies | Enable/Disable annotations on content text | siteConfig.yml | selectedTextContextMenu/comments/enabled |
| 22 | Text annotations length | Taxonomies | The max. length of a text annotation | siteConfig.yml | selectedTextContextMenu/comments/maxChars |
| 23 | Text annotation words | Taxonomies | The maximum number of words of a text annotation | siteConfig.yml | selectedTextContextMenu/comments/maxWords |
| 24 | Tags from selected text words | Taxonomies | The maximum number of words selected that can generate a custom tag | siteConfig.yml | selectedTextContextMenu/tags/maxWords |
| 25 | Tags from selected text length | Taxonomies | The maximum number of characters selected that can generate a custom tag | siteConfig.yml | selectedTextContextMenu/tags/maxChars |
| 26 | Auto save custom taxonomies | Taxonomies | Enable/Disable autosave option for the current custom taxonomies before loading a new configuration | siteConfig.yml | savedItems/autoSaveBeforeLoad |
| 27 | Multilanguage | Multilanguage | Enable/Disable multilanguage for the site | siteConfig.yml | multilang/enabled |
| 28 | Available languages | Multilanguage | List the site's available languages | siteConfig.yml | multilang/availableLang |
| 29 | Default language | Multilanguage | The default language of the site as position inside the array of available languages (starting with 0) | siteConfig.yml | multilang/siteLanguage |
| 30 | Fallback language | Multilanguage | The language which is automatically set if the site cannot use a certain user selected language (i.e. the translation file(s) are not found) s position inside the array of available languages (starting with 0) | siteConfig.yml | multilang/fallbackLang |
| 31 | Table pagination | General Feature | The number of pagination buttons (except the arrow buttons) shown in the tables pagination control (used for better display on mobile devices for long tables) | siteConfig.yml | dataTables/paginationButtons |
| 32 | Rows per page in tables | General Feature | The default number of rows shown on page for tables | siteConfig.yml | dataTables/rowsPerPage |
| 33 | Maximum row height | General Feature | The maximum height of a table row (in px) used for dynamic column's widths calculation and resizing | siteConfig.yml | dataTables/maxRowHeight |
| 34 | Python support | General Feature | Enable/Disable Python (used for various functionalities during build time) | buildConfig.yml | pyEnable |
| 35 | Python launch | General Feature | The python launch command used to run python scripts | buildConfig.yml | pyLaunch |
| 36 | Generate doc summary | Auto summaries | Enable/Disable automatically doc summary generation | buildConfig.yml | pyPageSummary/allInOneStep |
| 37 | Doc summary length | Auto summaries | Max. no. of words in generated doc summary | buildConfig.yml | pyPageSummary/summaryLength |
| 38 | Use a model prompt for doc summary generation | Auto summaries | Enable/Disable usage of a model(tokenizer) prompt for summary generation (some models doesn't need prompts) | buildConfig.yml | pyPageSummary/usePrompt |
| 39 | Doc summarisation model | Auto summaries | The Huggingface summarisation model used for generating doc Summary (different models may be set for different languages) | buildConfig.yml | pyPageSummary/model/name |
| 40 | Doc summarisation model parameters | Auto summaries | Parameters to tune the summarisation model | buildConfig.yml | pyPageSummary/model |
| 41 | Summarisation model prompt | Auto summaries | The prompt used for the model for generating the doc summary (if the model accepts prompts) | buildConfig.yml | pyPageSummary/tokenizer/prompt |
| 42 | Doc summarisation model tokenizer parameters | Auto summaries | Parameters to tune the summarisation tokenizer | buildConfig.yml | pyPageSummary/tokenizer |
| 43 | Run pre-build checks | General Feature | Enable/Disable automatically run for some checks, before building the site | buildConfig.yml | preFlight |
| 44 | Related docs | Auto related docs | Enable/Disable generation of the related pages for each doc | buildConfig.yml | relatedPages/enable |
| 45 | Related docs number | Auto related docs | Set how many related pages are selected in the descending order of the calculated score | buildConfig.yml | relatedPages/relPagesNo |
| 46 | Related docs score sensitivity | Auto related docs | Set the sensitivity of the score when deciding if two docs are related | buildConfig.yml | relatedPages/scoreLimit |
| 47 | Related pages score elements weights | Auto related docs | Set the weight of the elements contributing to the related docs score (the sume of weights must be 1) | buildConfig.yml | relatedPages/tf_idf_weigths |
| 48 | Auto excerpt parameters | Auto excerpt | Set the parameters (min. no of words, min. lengrh of a keyword) for doc exceprt generation (will be generated if the document does not have the 'excerpt' prop in the front matter) | buildConfig.yml | autoExcerpt/keywords minKeywordLength |
| 49 | Similar documents | Auto similar docs | Enable/Disable the automatic generation of a list (ordered desc by a similarity score) of documents with similar content with the current document | buildConfig.yml | pySimilarPagesByContent/enable |
| 50 | Similarity threshold | Auto similar docs | Minimum similarity score from which 2 documents may be considered as being similar | buildConfig.yml | pySimilarPagesByContent/similarity_threshold |
| 51 | Siimilarity model | Auto similar docs | The open source model (Huggingface url) used to generate the similarity scores | buildConfig.yml | pySimilarPagesByContent/model_url |
| 52 | Keywords | Auto keywords | Enable/Disable automatic keywords generation for documents | buildConfig.yml | pageKeywords/enable |
| 53 | Keywords model | Auto keywords | The open source model (Huggingface url) used to generate the keywords | buildConfig.yml | pageKeywords/model |
| 54 | No. of keywords | Auto keywords | The min. and max. number of keywords that will be generated for a document | buildConfig.yml | pageKeywords/minKeywords (maxKeywords) |
| 55 | GitHub integration | Integrations | Enable/Disable GitHub integration | buildConfig.yml | github/enabled |
| 56 | GitHub user | Integrations | GitHub user of organisation used for integration | buildConfig.yml | github/user |
| 57 | GitHub repository | Integrations | Usually the repository where the documentation is stored. It can be also the repository where the documentation subject matter is storred (such as a softwware product). Must be a public repository. | buildConfig.yml | github/repo |
| 58 | GitHub discussion organisation | Integrations | The GitHub organisation on which discussions were about the documentation or the subject matter of the documentation are enabled | buildConfig.yml | github/discussionOrg |
| 59 | Reading time | Documents | Enable/Disable the automatic calculation of the estimated document reading time | buildConfig.yml | readingTime/enabled |
| 60 | Reading time parameters | Documents | The parameters used in the calculation of the document reading time (adult avg reading speed, reading speed when focusing on comprehension, speed reading rate) | buildConfig.yml | readingTime/average_adult (comprehension_study; skimming_study) |
| 61 | Algolia search settings | Algolia search | Parameters used in browser to configure Algolia DocSearch client (see Algolia DocSearch documentation) | buildConfig.yml | algoliaSearch |
| 62 | Left footer content | General Feature | Content to be shown in the left sidebar footer (i.e. copyright info, links to Terms, Privacy, etc.) | buildConfig.yml | siteFooter/rows |
| 63 | GA integration | Integrations | Enable/Disable Google Analytics integration | buildConfig.yml | googleAnalytics/enabled |
| 64 | GA id | Integrations | Google Analytics property (G-….) | buildConfig.yml | googleAnalytics/ga |
| 65 | GTM integration | Integrations | Enable/Disable Google Tag Manager integration | buildConfig.yml | googleTagManager/enabled |
| 66 | GTM id | Integrations | Google Tag Manager ID (GTM-….) | buildConfig.yml | googleTagManager/gtm |
| 67 | Breadcrumbs depth | General Feature | Set the depth of breadcrumbs which are shown for parent-child documents | buildConfig.yml | breadcrumbs/depth |
| 68 | HubSpot Portal ID | Integrations | The HubSpot portal ID in case if HubSpot integration is enabled (see HubSpot documentation) | buildConfig.yml | hubspot/portalID |
| 69 | HubSpot region | Integrations | The region of HubSpot portal (see HubSpot documentation) | buildConfig.yml | hubspot/region |
| 70 | HubSpot feedback form | Integrations | The ID of the HubSpot form used for feedback (Ws the doc useful?) | buildConfig.yml | hubspot/feedbackFormID/ID |
| 71 | FAQ | General Feature | Enable/Disable FAQ page | buildConfig.yml | faq/enabled |
| 72 | FAQ pagination | General Feature | Enable/Disable pagination for FAQ page | buildConfig.yml | faq/pagination |
| 73 | FAQ pagination buttons (desktop) | General Feature | Number of questions per FAQ page on desktop (if pagination is enabled) | buildConfig.yml | faq/displayedPagesDesktop |
| 74 | FAQ pagination buttons (mobile) | General Feature | Number of questions per FAQ page on mobile (if pagination is enabled) | buildConfig.yml | faq/displayedPagesMobile |
| 75 | Questions per page | General Feature | Number of questions per page (if pagination is enabled) | buildConfig.yml | faq/perPage |
| 76 | FAQ ToC | General Feature | Include/Exclude questions from page ToC | buildConfig.yml | faq/faqToc |
| 77 | Components settings | Components | Settings for some of the components | buildConfig.yml | elements |
| 78 | Figma component | Components | Settings for Figma component | buildConfig.yml | elements/figma |
| 79 | Figma load message | Components | The message sent by Figma embed API when an item is loaded | buildConfig.yml | elements/figma/loadMessage |
| 80 | Figma embed url | Components | The url used by Figma embed API | buildConfig.yml | elements/figma/embedSourceUrl |
| 81 | Figma base url | Components | Figma url | buildConfig.yml | elements/figma/figmaBaseUrl |
| 82 | Embed allowed urls | Components | The urls from which to allow embedding components | buildConfig.yml | elements/figma/allowedUrl |
| 83 | Card settings | Components | Settings for card component | buildConfig.yml | elements/card |
| 84 | Default card width | Components | The default width of a card | buildConfig.yml | elements/card/cardWidth |
| 85 | Default card image height | Components | The default height of images in card header | buildConfig.yml | elements/card/cardImgHeight |
| 86 | Default card text size | Components | The defaul size of the fonts of the text inside card body | buildConfig.yml | elements/card/cardImgText |
| 87 | DOCX/PDF summary | Components | Settings for the component generating DOCX/PDF summaries | buildConfig.yml | extDocSummary |
| 88 | DOCX summarisation model | Components | The model used for generating DOCX summaries | buildConfig.yml | extDocSummary/word_sum_model |
| 89 | PDF summarisatiion model | Components | The model used to generate PDF summaries | buildConfig.yml | extDocSummary/pdf_sum_model |
| 90 | Spell check | General Feature | Enable/Disable spell checking at build time | buildConfig.yml | spellCheck |
| 91 | Customise Home page (build time) | Home page | Settings for the home page | pageBuildConfig.yml | / |
| 92 | Site entry document | Home page | The permalink of the document that is the entry of the documentation (such as Introduction or similar) | pageBuildConfig.yml | //startPermalink |
| 93 | Home page sections | Home page | Settings for the sections of the home page | pageBuildConfig.yml | /sections |
| 94 | Header section | Home page | Settinggs for the header section of the home page | pageBuildConfig.yml | /sections/header_section |
| 95 | Documentation title | Home page | Documentation title (may be different and more detailed than the site title from _config.yml) | pageBuildConfig.yml | /sections/header_section/title |
| 96 | Section text | Home page | The text shown under the title as description of the site/documetation | pageBuildConfig.yml | /sections/header_section/text |
| 97 | Text on the start link button | Home page | The text shown on the link button under the text in the header section. The button targets the entry document, using the permalink earlier explained | pageBuildConfig.yml | /sections/header_section/startBtnText |
| 98 | Content of the right column | Home page | The content (usually media content - image, video) shown on the right column of the header section | pageBuildConfig.yml | /sections/header_section/featuredMedia |
| 99 | Collection section | Home page | Settings for the collection section of the home page | pageBuildConfig.yml | /sections/collections_section |
| 100 | Show collections on home page | Home page | Enable/Disable collection section on the home page | pageBuildConfig.yml | /sections/collections_section/enabledInHome |
| 101 | Collection exceptions | Home page | List the collections that are NOT shown in the collections section | pageBuildConfig.yml | /sections/collections_section/except |
| 102 | Show docs from collections | Home page | The number of documents that are shown in each collection from the collections section (in DESC order of las modified date) | pageBuildConfig.yml | /sections/collections_section/itemsToShow |
| 103 | Text on collection entry point link button | Home page | The text shown on the link button that points to a collection entry document (if such entry document is defined for a collection) | pageBuildConfig.yml | /sections/collections_section/collectionStartBtnText |
| 104 | Collection entry point link button type | Home page | The class of the link button pointing to the collection entry document (see Bootstrap buttons) | pageBuildConfig.yml | /sections/collections_section/buttonsClass |
| 105 | Collection entry point link button text type | Home page | The class of the text shown on the link button | pageBuildConfig.yml | /sections/collections_section/buttonsTextClass |
| 106 | Most recent and popular docs section | Home page | Settings for the section containing the most recent and most popular documents | pageBuildConfig.yml | /sections/mostRecentAndPopular_section |
| 107 | Documents shown in the most recent and popular docs section | Home page | The number of documenrts shown in the most recent and popular docs section | pageBuildConfig.yml | /sections/mostRecentAndPopular_section/recentFilesToShow |
| 108 | Link to the list of all documents | Home page | The text on the button pointing to the list of all documents | pageBuildConfig.yml | /sections/mostRecentAndPopular_section/allDocsBtnText |
| 109 | Link to the list of all categories | Home page | The text on the link button pointing to the list of all categories | pageBuildConfig.yml | /sections/mostRecentAndPopular_section/allCatsBtnText |
| 110 | Link to the list of all tags | Home page | The text on the button pointing to the list of all tags | pageBuildConfig.yml | /sections/mostRecentAndPopular_section/allTagsBtnText |
| 111 | The type of the buttons at the bottom of each column of the most recent and popular docs section | Home page | The class of the link buttons pointing to the list of all documents, categories and tags (see Bootstrap buttons) | pageBuildConfig.yml | /sections/mostRecentAndPopular_section/buttonsClass |
| 112 | The type of the text shown on the buttons at the bottom of each column of the most recent and popular docs section | Home page | The class of the text shown on the link buttons pointing to the list of all documents, categories and tags (see Bootstrap text classes) | pageBuildConfig.yml | /sections/mostRecentAndPopular_section/buttonsTextClass |
| 113 | Statistics section | Home page | Settings for the documentation statistics section | pageBuildConfig.yml | /sections/stats_section |
| 114 | Link buttons type | Home page | The class of link buttons from the statistics section of the home page | pageBuildConfig.yml | /sections/stats_section/buttonsClass |
| 115 | Link buttons text type | Home page | The class of the text (icon) shown on the link buttons in the statistics section of the home page | pageBuildConfig.yml | /sections/stats_section/buttonsTextClass |
| 116 | Link buttons icon | Home page | The icon shown on the link buttons in the statistics section of the home page (see Bootstrap icons) | pageBuildConfig.yml | /sections/stats_section/buttonsIcon |
| 117 | Customise Home page (run time) | Home page | Settings for the home page applied at run time | pageBuildConfig.yml | / |
| 118 | Number of popular categories | Home page | Top X categories based on the number of documents (ordered DESC) | pageBuildConfig.yml | /sections/mostRecentAndPopular_section/popularCatsToShow |
| 119 | Number of popular tags | Home page | Top X tags based on the number of documents (ordered DESC) | pageBuildConfig.yml | /sections/mostRecentAndPopular_section/popularTagsToShow |
On this page
Comments
Reference : anchor