Skip to content

Commit

Permalink
feat(docs): upgrade mkdocs/mermaid
Browse files Browse the repository at this point in the history
  • Loading branch information
noelmcloughlin committed Aug 18, 2024
1 parent b2da87e commit 3c0c607
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
25 changes: 21 additions & 4 deletions {{cookiecutter.project_name}}/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,37 @@
site_name: "{{cookiecutter.project_name}}"
theme:
name: material
# palette:
# scheme: slate
# primary: cyan
palette:
# https://github.com/facelessuser/mkdocs_pymdownx_material_extras
scheme: dracula
primary: deep purple
accent: deep purple
features:
- content.tabs.link

plugins:
- search
- mermaid2
- mermaid2:
# https://mkdocs-mermaid2.readthedocs.io/en/latest/library
version: 10.9.0
- mkdocs_pymdownx_material_extras

markdown_extensions:
- pymdownx.superfences:
# make exceptions to highlighting of code
custom_fences:
# activate display of Mermaid diagrams
- name: mermaid
class: mermaid
# https://pypi.org/project/mkdocs-pymdownx-material-extras
# https://mkdocs-mermaid2.readthedocs.io/en/latest/superfences
format: !!python/name:pymdownx.superfences.fence_code_format

nav:
# - Home: home.md
- Index: index.md
- About: about.md

site_url: https://{{cookiecutter.github_org}}.github.io/{{cookiecutter.project_name}}
repo_url: https://github.com/{{cookiecutter.github_org}}/{{cookiecutter.project_name}}

Expand Down
3 changes: 2 additions & 1 deletion {{cookiecutter.project_name}}/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ style = "pep440"

[tool.poetry.dev-dependencies]
linkml = "^1.3.5"
mkdocs-material = "^8.2.8"
mkdocs-material = "^9.5.11"
mkdocs-mermaid2-plugin = "^1.1.1"
mkdocs-pymdownx-material-extras = "^2.5.6"
schemasheets = "^0.1.14"

[build-system]
Expand Down

0 comments on commit 3c0c607

Please sign in to comment.