Skip to content

Commit ae5c45c

Browse files
feat(docs): upgrade mkdocs/mermaid
1 parent 59c7180 commit ae5c45c

File tree

3 files changed

+30
-7
lines changed

3 files changed

+30
-7
lines changed

.github/workflows/codespell.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,6 @@ jobs:
2020
uses: actions/checkout@v3
2121
- name: Codespell
2222
uses: codespell-project/actions-codespell@v2
23+
with:
24+
skip: *.js
25+

{{cookiecutter.project_name}}/mkdocs.yml

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,37 @@
22
site_name: "{{cookiecutter.project_name}}"
33
theme:
44
name: material
5-
# palette:
6-
# scheme: slate
7-
# primary: cyan
5+
palette:
6+
# https://github.com/facelessuser/mkdocs_pymdownx_material_extras
7+
scheme: dracula
8+
primary: deep purple
9+
accent: deep purple
810
features:
911
- content.tabs.link
12+
1013
plugins:
1114
- search
12-
- mermaid2
15+
- mermaid2:
16+
# https://mkdocs-mermaid2.readthedocs.io/en/latest/library
17+
version: 10.9.0
18+
- mkdocs_pymdownx_material_extras
19+
20+
markdown_extensions:
21+
- pymdownx.superfences:
22+
# make exceptions to highlighting of code
23+
custom_fences:
24+
# activate display of Mermaid diagrams
25+
- name: mermaid
26+
class: mermaid
27+
# https://pypi.org/project/mkdocs-pymdownx-material-extras
28+
# https://mkdocs-mermaid2.readthedocs.io/en/latest/superfences
29+
format: !!python/name:pymdownx.superfences.fence_code_format
30+
1331
nav:
1432
# - Home: home.md
1533
- Index: index.md
1634
- About: about.md
35+
1736
site_url: https://{{cookiecutter.github_org}}.github.io/{{cookiecutter.project_name}}
1837
repo_url: https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.project_name}}
1938

{{cookiecutter.project_name}}/pyproject.toml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,14 @@ style = "pep440"
1818

1919
[tool.poetry.dev-dependencies]
2020
linkml = "^1.3.5"
21-
mkdocs-material = "^8.2.8"
22-
mkdocs-mermaid2-plugin = "^0.6.0"
21+
mkdocs-material = "^9.5.11"
22+
mkdocs-mermaid2-plugin = "^1.1.1"
23+
mkdocs-pymdownx-material-extras = "^2.5.6"
2324
schemasheets = "^0.1.14"
2425

2526
[build-system]
2627
requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
2728
build-backend = "poetry_dynamic_versioning.backend"
2829

2930
[tool.poetry.extras]
30-
docs = ["linkml", "mkdocs-material"]
31+
docs = ["linkml", "mkdocs-material"]

0 commit comments

Comments
 (0)