Skip to content

Commit 3c0c607

Browse files
feat(docs): upgrade mkdocs/mermaid
1 parent b2da87e commit 3c0c607

File tree

2 files changed

+23
-5
lines changed

2 files changed

+23
-5
lines changed

{{cookiecutter.project_name}}/mkdocs.yml

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +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
1315
- mermaid2:
16+
# https://mkdocs-mermaid2.readthedocs.io/en/latest/library
1417
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+
1531
nav:
1632
# - Home: home.md
1733
- Index: index.md
1834
- About: about.md
35+
1936
site_url: https://{{cookiecutter.github_org}}.github.io/{{cookiecutter.project_name}}
2037
repo_url: https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.project_name}}
2138

{{cookiecutter.project_name}}/pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ style = "pep440"
1818

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

2526
[build-system]

0 commit comments

Comments
 (0)