docs/mkdocs.yml at main · masc-ucsc/docs · 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
61
62
63
64
65
66
67
site_name: LiveHD and Pyrope

repo_url: https://github.com/masc-ucsc/livehd
  # edit_url: https://github.com/masc-ucsc/docs/edit/main/docs

remote_branch: gh-pages

plugins:
  - search

theme:
  name: material
  font:
    code: Fira Code
  logo: assets/pyrope5.png
  features:
    - search.suggest
    - navigation.sections
    - navigation.instant
    - navigation.indexes
      # - toc.integrate
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

markdown_extensions:
  - attr_list
  - pymdownx.arithmatex:
      generic: true
  - def_list
  - toc:
      permalink: true
      toc_depth: 4
  - admonition
  - footnotes
  - tables
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: pyrope
          class: pyrope
          format: !!python/name:pyrope_highlight.fence_pyrope
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid

extra_css:
  - stylesheets/table.css
  - stylesheets/pyrope-highlight.css

extra_javascript:
  - javascripts/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://unpkg.com/mermaid/dist/mermaid.min.js