Installation

Add a pinned release to docs/requirements.txt:

mkdocs-drupal-pages @ https://git.drupalcode.org/project/drupal_pages/-/archive/1.0.0/drupal_pages-1.0.0.tar.gz

Install with python -m pip install -r docs/requirements.txt. A full commit SHA may replace the release in both parts of the URL for an immutable pin.

Configure mkdocs.yml:

site_name: My project
theme:
  name: drupal-pages
extra_css:
  - assets/stylesheets/drupal-pages.css
extra_javascript:
  - assets/javascripts/drupal-pages.js
plugins:
  - material/search
markdown_extensions:
  - attr_list
  - md_in_html

For a project using Drupal's GitLab CI templates, add theme installation to .gitlab-ci.yml:

pages:
  before_script:
    - python -m pip install -r docs/requirements.txt

Then build with mkdocs build --strict or preview with mkdocs serve. See the repository README for project logos, home page templates, local overrides, and releases.