Docs theme

Documentation theme for Cecil, powered by Tailwind CSS and Algolia DocSearch.

Features

• Auto-generated navigation sidebar (based on nested sections)
• Algolia DocSearch integration
• Ready for content localization (l10n)
• Templates internationalization (i18n)
• Mobile friendly
• Dark theme
• Blog posts templates

Installation

composer require cecil/theme-docs

Or download the latest archive and uncompress its content in themes/docs.

Usage

Add docs in the theme section of the config.yml:

theme:
  - docs

Configuration

The navigation sidebar is generated automatically from the folders structure of pages/docs/, based on nested sections: each sub-folder containing an index.md file becomes a (collapsible) group, at any depth. Ordering is based on pages weight (e.g. a 1- filename prefix or a weight front matter variable).

footer: Copyright © %author%
github:
  repo: https://github.com/<org>/<repo>
  branch: <main|master>
docsearch:
  enabled: true|false
  appId: <YOUR_APP_ID>
  indexName: <YOUR_INDEX_NAME>
  apiKey: <YOUR_SEARCH_API_KEY>
  debug: false|true

Development

Install deps

composer install

Rebuild CSS

composer css:build

CSS is compiled with tailwind-builder, which uses the Tailwind standalone binary (no Node.js required).

License

Docs theme is a free software distributed under the terms of the MIT license.

© Arnaud Ligny