forked from mirrors/jj
44e1d4a72d
This is a rather annoying bug. It was revealed because CLI reference stopped working for *offline* docs after the previous commit. Turns out, none of the plugins we enabled for normal docs were turned on in `mkdocs-offline.yml`. Thanks to @mondeja for figuring out what was going on. In the future, we could try a less ugly fix, e.g. turning the `offline` plugin on or off via an environment variable. See also: https://github.com/squidfunk/mkdocs-material/issues/6749 https://github.com/mondeja/mkdocs-include-markdown-plugin/issues/195#issuecomment-1933085478
18 lines
693 B
YAML
18 lines
693 B
YAML
# 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:
|
|
# 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
|