From 3c0c60726a93f18cccfe5a38f3117424403fbfd4 Mon Sep 17 00:00:00 2001 From: noelmcloughlin Date: Mon, 19 Aug 2024 00:15:35 +0100 Subject: [PATCH] feat(docs): upgrade mkdocs/mermaid --- {{cookiecutter.project_name}}/mkdocs.yml | 25 ++++++++++++++++---- {{cookiecutter.project_name}}/pyproject.toml | 3 ++- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/{{cookiecutter.project_name}}/mkdocs.yml b/{{cookiecutter.project_name}}/mkdocs.yml index 68233d0..4c31019 100644 --- a/{{cookiecutter.project_name}}/mkdocs.yml +++ b/{{cookiecutter.project_name}}/mkdocs.yml @@ -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}} diff --git a/{{cookiecutter.project_name}}/pyproject.toml b/{{cookiecutter.project_name}}/pyproject.toml index 64ea5d8..2099919 100644 --- a/{{cookiecutter.project_name}}/pyproject.toml +++ b/{{cookiecutter.project_name}}/pyproject.toml @@ -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]