Zensical Docs Theme

A ready-made theme for the documentation of any project on drupal.org, built with Zensical and published with GitLab Pages on git.drupalcode.org. Copy it into your repository, replace four placeholders, write your pages in Markdown, push – and your project has documentation in Drupal colours.

It started as the documentation theme of Default Content Locale Extended and the Drupal CMS German Installer. See it in action: dcle documentation, dcgi documentation.

Features

• Drupal colours and typefaces: Drupal Blue, Dark Blue, Navy and Yellow, Noto Sans and Outfit. Contrast meets WCAG AA.
• Dark mode without a light flash: the preferred colour scheme applies before the first paint.
• Link previews for Facebook, Mastodon, LinkedIn and others: Open Graph and Twitter tags, a preview image per page if you like, and a script that renders preview images in the same design.
• English and German with a language selector that leads to the same page in the other language. One language works too.
• Screenshots, galleries and slideshows with a lightbox: keyboard, buttons and swipe; works without JavaScript as a plain gallery.
• GitLab Pages job for a project of its own, or for a module or theme that includes the Drupal GitLab CI templates – with the settings that keep CSpell, ESLint and Stylelint away from the documentation.
• No third-party requests: the typefaces are downloaded at build time and served with the documentation.

Getting started

1. Download the repository and copy its files into the root of your project.
2. Replace PROJECT_NAME, PROJECT_SLUG, BRANCH and PAGES_DOMAIN in the configuration.
3. Write your pages in docs/en/ and docs/de/.
4. Build locally with bash scripts/build-docs.sh, then push.

The README (English) and README.de.md (German) explain every step, including how to add the theme to an existing module or theme without breaking its pipeline.

Requirements

• Python 3 and pip install zensical
• For the preview images: Playwright
• A project on drupal.org (for GitLab Pages)

License and trademark

The code is licensed under the GPL, version 2 or later, like Drupal itself. The Drupal drop used as the logo of the documentation is a trademark of Dries Buytaert; see the Drupal trademark policy. The typefaces Noto Sans and Outfit are licensed under the SIL Open Font License and are not part of the repository.