jj/mkdocs-offline.yml

20 lines
731 B
YAML
Raw Normal View History

# This config is good if you plan to use the rendered docs from
# your file system. To use, run:
# poetry run -- mkdocs build -f mkdocs-offline.yml
INHERIT: 'mkdocs.yml'
plugins:
- offline
# For now, *every plugin config* from `mkdocs.yml` has to be repeated here.
# https://github.com/mondeja/mkdocs-include-markdown-plugin/issues/195#issuecomment-1933085478
# https://github.com/mkdocs/mkdocs/issues/3216
- include-markdown # For the CLI reference
- search
- redirects:
redirect_maps:
branches.md: bookmarks.md
# Turns out the `offline` plugin forces the following
# option no matter what, and therefore shouldn't be
# used in the main config file.
use_directory_urls: false