LibDoc’s configuration
List and descriptions of every LibDoc parameter
2025-05-23
ITADS
Here is the default LibDoc’s configuration. Each parameter can be overridden through the file settings.json
at the root of the project.
Even if settings.json
can be empty, it is recommended to enter at least:
siteTitle
siteDescription
faviconUrl
If not specified in settings.json
, the following parameters are applied:
{
"lang": "en",
"siteTitle": "11ty LibDoc",
"siteDescription": "An Eleventy starter project to craft slick documentation",
"siteLogoUrl": "",
"siteLogoMaxHeight": 60,
"author": false,
"faviconUrl": "/favicon.png",
"ogImageUrl": "https://raw.githubusercontent.com/ita-design-system/ita-medias/refs/heads/main/ogimage-11ty-libdoc.png",
"customLinks": [],
"blogTitle": "Blog Posts",
"blogDescription": false,
"blogAuthor": false,
"blogSlug": "posts",
"displayTagsListLink": true,
"tocEnabled": true,
"tocHtmlTags": ["h1", "h2", "h3", "h4", "h5", "h6"],
"tocMinTags": 1,
"htmlBasePathPrefix": "",
"sandboxRunSwitch": true,
"searchEnabled": true,
"hljsLanguages": [
"xml",
"javascript",
"json",
"yaml",
"liquid",
"markdown",
"css"
],
"roundedImagesCorners": true,
"editThisPageRootUrl": false
}
Parameter | Type | Description | Page override |
---|---|---|---|
lang |
String | Locale of the project, required for every message of the user interface | yes |
siteTitle |
String | Site title of the project | no |
siteDescription |
String | Site description of the project | no |
siteLogoUrl |
String | Optional site logo URL | no |
siteLogoMaxHeight |
Integer | If site logo URL is set, adjusts logo maximum height in pixels | no |
author |
String or false | Default author of pages. Setting to false disables author display | yes |
faviconUrl |
String | Favicon URL configuration | yes |
ogImageUrl |
String | Metadata of the default Open Graph Image | yes |
customLinks |
Array | Array of objects defining custom links into the primary navigation | no |
customLinks[i].text |
String | Link text | no |
customLinks[i].url |
String | Link URL | no |
blogTitle |
String | Sets the blog title | no |
blogDescription |
String or false | Sets the blog description | no |
blogAuthor |
String or false | Sets the blog author | no |
blogSlug |
String | Sets the slug for the blog | no |
displayTagsListLink |
Boolean | Enable or disable the link that opens tags list page | no |
tocEnabled |
Boolean | Enable or disable Table of Content | yes |
tocHtmlTags |
Array | List of tags to support into the Table of Content | no |
tocMinTags |
Integer | Minimum amount of headings detected to enable Table of Content | no |
htmlBasePathPrefix |
String | Configure your HTML base path prefix | no |
sandboxRunSwitch |
Boolean | Enable disable scroll into sandbox instead of page | no |
searchEnabled |
Boolean | Enable disable search feature | no |
hljsLanguages |
Array | List of supported languages for syntax highlighting, just add aliases according to your needs | no |
roundedImagesCorners |
Boolean | Enable disable rounded image corners by default | no |
editThisPageRootUrl |
String or false | Sets the git root directory project’s URL to enable edit this page link | no |