react-squirrel/mkdocs.yml at main · slaclab/react-squirrel · 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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# Project Information
site_name: Squirrel
site_url: https://slaclab.github.io/react-squirrel/
site_author: SLAC National Accelerator Laboratory - AD / EED / Software Applications Group
site_description: User guide for Squirrel - EPICS PV Configuration Management

# Repository
repo_name: slaclab/react-squirrel
repo_url: https://github.com/slaclab/react-squirrel

# Configuration
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.copy
    - navigation.top
    - navigation.tabs
    - navigation.indexes
    - navigation.footer
    - navigation.sections
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

# Plugins
plugins:
  - search
  - git-revision-date-localized:
      exclude:
        - index.md
      enable_creation_date: true
      fallback_to_build_date: true
      enable_git_follow: false
  - git-committers:
      exclude:
        - index.md
      repository: slaclab/react-squirrel
      branch: main

# Additional Configuration
extra:
  generator: false

extra_css:
  - stylesheets/extra.css

# Extensions
markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - tables

# Page Tree
nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - User Guide:
      - user-guide/index.md
      - Snapshots: user-guide/snapshots.md
      - Snapshot Comparison: user-guide/snapshot-comparison.md
      - PV Browser: user-guide/pv-browser.md
      - PV Details: user-guide/pv-details.md
      - Tags: user-guide/tags.md
      - Restore: user-guide/restore.md
      - API Keys: user-guide/api-keys.md