Skip to content

Commit b2e6740

Browse files
feat(docs): upgrade mkdocs/mermaid
1 parent 07462f0 commit b2e6740

File tree

4 files changed

+1855
-7
lines changed

4 files changed

+1855
-7
lines changed

.github/workflows/codespell.yml

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

{{cookiecutter.project_name}}/mkdocs.yml

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,40 @@
11
---
22
site_name: "{{cookiecutter.project_name}}"
3+
docs_dir: docs
34
theme:
45
name: material
5-
# palette:
6-
# scheme: slate
7-
# primary: cyan
6+
palette:
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+
- mkdocs_pymdownx_material_extras
16+
- mermaid2:
17+
# prevent mkdocs-mermaid2-plugin from pulling (a version) from internet
18+
# which does not work in sandboxed environment anyway
19+
version: 10.8.0
20+
javascript: ./js/mermaid.min.js
21+
22+
markdown_extensions:
23+
- pymdownx.superfences:
24+
# make exceptions to highlighting of code
25+
custom_fences:
26+
# activate display of Mermaid diagrams
27+
- name: mermaid
28+
class: mermaid
29+
# https://pypi.org/project/mkdocs-pymdownx-material-extras
30+
# https://mkdocs-mermaid2.readthedocs.io/en/latest/superfences
31+
format: !!python/name:pymdownx.superfences.fence_code_format
32+
1333
nav:
1434
# - Home: home.md
1535
- Index: index.md
1636
- About: about.md
37+
1738
site_url: https://{{cookiecutter.github_org}}.github.io/{{cookiecutter.project_name}}
1839
repo_url: https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.project_name}}
1940

{{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"]

{{cookiecutter.project_name}}/src/docs/js/mermaid.min.js

Lines changed: 1824 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)