diff --git a/composer.json b/composer.json index c699d564..e1d6b495 100644 --- a/composer.json +++ b/composer.json @@ -69,8 +69,8 @@ ], "doc": [ "Composer\\Config::disableProcessTimeout", - "pip install -r docs/requirements.txt", - "mkdocs serve --config-file docs/mkdocs.yml" + "docker build -t valinor-doc ./docs", + "docker run --name valinor-doc --rm -it -p 8000:8000 -v ${PWD}/docs:/docs valinor-doc" ] }, "config": { diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 00000000..72660db5 --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,3 @@ +FROM squidfunk/mkdocs-material +COPY requirements.txt /tmp/requirements.txt +RUN pip install -r /tmp/requirements.txt diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9ec81062..75151acb 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -36,6 +36,7 @@ theme: - navigation.sections - navigation.top - navigation.indexes + - navigation.instant - content.code.annotate palette: - media: "(prefers-color-scheme: light)" @@ -97,3 +98,4 @@ nav: - Alternatives: project/alternatives.md - Changelog: project/changelog.md - Credits: project/credits.md +not_in_nav: project/changelog/version-*.md diff --git a/docs/requirements.txt b/docs/requirements.txt index b4bec455..9b6ae7fc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,13 +1,10 @@ -mkdocs==1.3.0 -markdown==3.3.7 -mkdocs-material==8.2.3 +mkdocs==1.5.3 +mkdocs-material==9.4.3 +mkdocs-material-extensions==1.2 -# Use mike=1.2.x when available -git+https://github.com/jimporter/mike@392d57b8bb9d14bcedf2451a0dc302709f8055eb +mike==1.1.2 # Markdown extensions -Pygments==2.12.0 -pymdown-extensions==9.4 - -# MkDocs plugins -mkdocs-material-extensions==1.0.3 +markdown==3.3.7 +Pygments==2.16.1 +pymdown-extensions==10.3