Skip to content

Commit

Permalink
feat: test new mkdocs config
Browse files Browse the repository at this point in the history
  • Loading branch information
noelmcloughlin committed Aug 18, 2024
1 parent b2da87e commit 26be45d
Show file tree
Hide file tree
Showing 5 changed files with 1,858 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,6 @@ jobs:
uses: actions/checkout@v3
- name: Codespell
uses: codespell-project/actions-codespell@v2
with:
skip: *.js

6 changes: 5 additions & 1 deletion cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,9 @@
"google_sheet_id": "1wVoaiFg47aT9YWNeRfTZ8tYHN8s8PAuDx5i2HUcDpvQ",
"google_sheet_tabs": "personinfo enums",
"__google_sheet_module": "{{ cookiecutter.google_sheet_tabs|lower()|replace(' ', '_')|replace('-', '_') }}",
"github_token_for_pypi_deployment": "PYPI_PASSWORD"
"github_token_for_pypi_deployment": "PYPI_PASSWORD",
"_copy_without_render": [
"src/docs/js/*",
"src/docs/javascript/*"
]
}
27 changes: 24 additions & 3 deletions {{cookiecutter.project_name}}/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,41 @@
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
- mkdocs_pymdownx_material_extras
- mermaid2
- mermaid2:
version: 10.9.0
- mermaid2:
# support for sandbox environment, no cdn access
version: 10.8.0
javascript: ./js/mermaid.min.js

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.31"
mkdocs-mermaid2-plugin = "^1.1.1"
mkdocs-pymdownx-material-extras = "^2.5.6"
schemasheets = "^0.1.14"

[build-system]
Expand Down
1,824 changes: 1,824 additions & 0 deletions {{cookiecutter.project_name}}/src/docs/js/mermaid.min.js

Large diffs are not rendered by default.

0 comments on commit 26be45d

Please sign in to comment.