Skip to content

Commit 6d8cd01

Browse files
committed
Use mike to versionise the website.
Add `mike` as a documentation dependency and configure mkdocs to use it. This allows to versionise the entire website.
1 parent fc7fc30 commit 6d8cd01

5 files changed

Lines changed: 36 additions & 1 deletion

File tree

.github/workflows/deploy_documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ jobs:
5555
#----------------------------------------------
5656
- name: Deploy web-based documentation to GitHub Pages
5757
run: |
58-
make mkd-gh-deploy
58+
make deploy-doc

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,9 @@ MKDOCS = $(RUN) --all-groups mkdocs
102102
mkd-%:
103103
$(MKDOCS) $*
104104

105+
deploy-doc:
106+
$(RUN) mike deploy --push dev
107+
105108
PROJECT_FOLDERS = sqlschema shex shacl protobuf prefixmap owl jsonschema jsonld graphql excel
106109
git-init-add: git-init git-add git-commit git-status
107110
git-init:

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ theme:
99
# primary: cyan
1010
features:
1111
- content.tabs.link
12+
extra:
13+
version:
14+
provider: mike
1215
plugins:
1316
- search
1417
- mermaid2

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ tests = [
4040
docs = [
4141
"mkdocs-material==9.0.0",
4242
"mkdocs-mermaid2-plugin==1.1.1",
43+
"mike"
4344
]
4445

4546
[tool.poetry]

uv.lock

Lines changed: 28 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)