ChemGraph/mkdocs.yml at main · argonne-lcf/ChemGraph · 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
68
69
70
71
72
73
74
75
76
77
78
79
80
site_name: ChemGraph Docs
repo_name: ChemGraph
repo_url: https://github.com/argonne-lcf/ChemGraph/tree/

theme:
  name: material

  # Font settings
  font:
    text: Merriweather Sans
    code: Roboto Mono

  features:
    - content.code.copy
    - content.code.annotate
    - navigation.footer
    - search.suggest
    - header.autohide
    - navigation.tabs

  palette:
    # Automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Light Mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: green
      accent: deep purple

    # Dark Mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preferences
      primary: indigo
      accent: deep orange

plugins:
  - mkdocstrings
  - search

nav:
  - Overview: index.md
  - Installation: installation.md
  - Example Usage: example_usage.md
  - Streamlit Web Interface: streamlit_web_interface.md
  - MCP Servers: mcp_servers.md
  - Configuration with TOML: configuration_with_toml.md
  - Project Structure: project_structure.md
  - Running Local Models with vLLM: running_local_models.md
  - Docker Support: docker_support.md
  - Code Formatting & Linting: code_formatting_and_linting.md
  - Citation: citation.md
  - Acknowledgements: acknowledgements.md
  - License: license.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true