josim-tools/mkdocs.yml at master · JoeyDelp/josim-tools · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
site_name: JoSIM Tools Documentation
repo_url: https://github.com/JoeyDelp/josim-tools
repo_name: JoeyDelp/josim-tools
site_author: Johannes Delport
edit_uri: ""

nav:
    - Introduction: 'index.md'
    - Configuration: 'configuration_file.md'
    - Example Usage: 'example_usage.md'

theme:
  name: material
  palette:
    scheme: preference
    primary: black
  highlightjs: true
  hljs_languages:
    - bash
    - c++
    - python
  favicon: img/favicon.ico
  logo: img/favicon.ico
  features:
    - toc.integrate
    - header.autohide
  icon:
    repo: fontawesome/brands/github-alt
site_dir: build/mkdocs

extra_javascript:
    - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML
    - https://unpkg.com/mermaid/dist/mermaid.min.js

plugins:
    - mermaid2

markdown_extensions:
  - pymdownx.magiclink:
      repo_url_shorthand: True
      repo_url_shortener: True
      hide_protocol: True
  - pymdownx.superfences:
      # make exceptions to highlighting of code:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - pymdownx.highlight:
      linenums: false
  - mdx_math


extra:
    social:
        - icon: fontawesome/brands/github
          link: https://github.com/JoeyDelp
          name: JoeyDelp on GitHub

copyright: Copyright &copy; 2021 Johannes Delport