Skip to content
Logo
Statidocs
On this page

Configuration reference

The configuration of your site is defined in the cecil.yml file. Statidocs supports all Cecil configuration options, plus the following options of the Docs theme.

Site

Option Description Default
title Site title, displayed in the header and on the homepage.
baseline Short tagline, displayed on the homepage.
description Site description, used in meta tags.
author Site author (name, url).
logo Logo image (in assets/), or light and dark images.
footer Footer text (%author% is replaced by the author name). Copyright © %author%
Option Description Default
menus.main Header menu entries.
menus.footer Footer menu entries.
sidebar.collapsed Collapse the sidebar groups, except the one of the current page. false

Pages

Option Description Default
lastupdated Display the page date as “Last updated” date (updated is always displayed). false
language_cookie Name of a cookie storing the language chosen with the selector (e.g. nf_lang). false

GitHub

Option Description Default
github.url Repository URL, linked in the header.
github.repo Repository URL used by the “Edit this page” link.
github.branch Branch of the repository. main
github.path Path of the pages directory in the repository. pages

Search options are provided by the DocSearch and FlexSearch component themes, which must be installed and added to the theme section. See Site Search.

Option Description Default
docsearch.enabled Display the DocSearch search box. true
docsearch.appId Algolia application ID.
docsearch.indexName Algolia index name.
docsearch.apiKey Algolia search-only API key.
docsearch.language Filter the results on the current language. true
docsearch.insights Enable Algolia Insights. false
docsearch.debug Keep the search modal open (for debugging). false
flexsearch.enabled Display the FlexSearch search box. true
flexsearch.sections Indexed sections, in the order of the result groups. all

Example

title: Statidocs
baseline: Build a documentation website quickly
baseurl: https://statidocs.cecil.app/
author:
  name: Arnaud Ligny
  url: https://arnaudligny.fr
logo: logo.png
footer: Copyright © %author%
menus:
  main:
    - id: docs
      weight: 0
github:
  url: https://github.com/Cecilapp/statidocs
  repo: https://github.com/Cecilapp/statidocs.cecil.app
  branch: main
sidebar:
  collapsed: false
lastupdated: false
docsearch:
  enabled: true
  appId: <YOUR_APP_ID>
  indexName: <YOUR_INDEX_NAME>
  apiKey: <YOUR_SEARCH_API_KEY>
theme:
  - docs
  - docsearch
  - pwa