Исключение блоков кода русалки для выделения с помощью Codehilite (MkDocs) - PullRequest
0 голосов
/ 06 мая 2020

Я пытаюсь создать документацию из файлов уценки через mkdocs (с материалами) в publi sh на gitlab. Мои файлы включают блоки кода и диаграммы русалок, которые декларируются одинаково (с разными языками). Я хотел бы использовать CodeHilite для украшения блоков кода, но блоки русалки также будут обрабатываться им как блоки кода, а затем будут игнорироваться плагином mermaid-mkdocs. Есть ли способ исключить определенные блоки из codeHilite или любое другое изменение, чтобы использовать оба вместе?

1 Ответ

0 голосов
/ 19 мая 2020

У меня была точно такая же проблема, и я нашел следующее решение, используя расширение pymdownx (в комплекте с темой материала mkdocs, см. https://squidfunk.github.io/mkdocs-material/extensions/pymdown/):

Включите следующее в ваш mkdocs.yml:

markdown_extensions:
  - codehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format

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

Я не использую какие-либо дополнительные плагины mkdocs для русалки, например mermaid2.

Это решение основано на https://github.com/squidfunk/mkdocs-material/issues/693#issuecomment -411885426

...