scality / runner-manager

Service to manage github Actions self-hosted runners
https://scality.github.io/runner-manager/
Apache License 2.0
7 stars 9 forks source link

docs: include mermaid.js library #569

Closed lewismiddleton closed 6 months ago

lewismiddleton commented 6 months ago

Adds the minified mermaid.js library to the mkdocs extra_javascript.

Inspired by a comment on the original feature request at mkdocs-material for mermaid support.

Using the extra_javascript feature to include the minified mermaid.js library from https://unpkg.com/browse/mermaid@10.9.0/dist/

Resolves: #567

lewismiddleton commented 6 months ago

Here are some findings from my testing:

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
          # Doesn't work
          # format: !!python/name:pymdownx.superfences.fence_code_format

extra_javascript:
  - https://unpkg.com/mermaid@10.9.0/dist/mermaid.min.js

# Doesn't change behaviour
# extra_css:
#   - https://unpkg.com/mermaid@10.9.0/dist/mermaid.css