corral/mkdocs.yaml at main · lamalab-org/corral · 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
theme:
  name: terminal
  palette: dark

site_name: Corral Documentation
site_url: https://lamalab-org.github.io/corral/docs/


repo_name: lamalab-org/corral
repo_url: https://github.com/lamalab-org/corral

copyright: LAMAlab x M3RG


nav:
    - Home: 'index.md'
    - Setting Up: 'setting_up.md'
    - Documentation:
      - How-To-Guides: 'documentation/how_to_guides.md'
      - Tutorials: 'documentation/tutorials.md'
      - Explanations: 'documentation/explanation.md'
      - Reference: 'documentation/reference.md'
    - About Us: 'about_us.md'


markdown_extensions:
  # Python Markdown
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - meta
  - tables
  - admonition
  - toc:
      toc_depth: "2"
      permalink: "#"
      permalink_title: Anchor link to this section for reference
  - pymdownx.blocks.details:
      types:
        - name: info
          class: terminal-alert
          title: Info

  # PyMdown Extensions
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.superfences
  - pymdownx.highlight:
      use_pygments: true
      pygments_style: catppuccin-frappe
      noclasses: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - docs

extra_css:
  - copy-code.css

extra_javascript:
  - copy-code.js

plugins:
  - search
  - autorefs