StarshipHUD/mkdocs.yml at main · brentonmallen1/StarshipHUD · 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
site_name: Starship HUD
site_description: User documentation for Starship HUD - an immersive spaceship interface for tabletop RPGs
site_url: https://your-domain.com/docs

docs_dir: docs-user
site_dir: site

theme:
  name: material
  palette:
    scheme: slate
    primary: cyan
    accent: teal
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - search.highlight
  icon:
    logo: material/rocket-launch

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - First Run: getting-started/first-run.md
  - Guides:
      - For GMs: guide/gm-guide.md
      - For Players: guide/player-guide.md
      - Panels: guide/panels.md
      - Scenarios: guide/scenarios.md
  - Reference:
      - Widget Reference: reference/widgets.md
      - Status States: reference/status-states.md
      - Data Model: reference/data-model.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html

plugins:
  - search

extra:
  social: []

copyright: Starship HUD - Built for tabletop immersion