opensim-stack-docs/mkdocs.yml at main · opensim-stack/opensim-stack-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
68
69
70
71
72
73
74
75
76
77
78
site_name: OpenSim AI Stack Docs
site_description: Documentation suite for the OpenSim AI Docker stack and related components.
site_url: https://opensim-stack.github.io/docs/
repo_url: https://github.com/opensim-stack/opensim-ai-docker
repo_name: opensim-stack/opensim-ai-docker

theme:
  name: material
  palette:
    scheme: slate
    primary: deep purple
    accent: cyan
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.highlight
    - search.suggest

nav:
  - Introduction: index.md
  - Beginner Guide:
      - Quick Start: beginner/quick-start.md
      - Voice (Piper TTS): beginner/voice.md
      - Movement and Animation: beginner/movement-animation.md
      - Appearance and Wearables: beginner/appearance.md
      - Building: beginner/building.md
      - Content (Mesh Upload): beginner/content.md
      - Land Basics: beginner/land.md
      - Social and Groups: beginner/social.md
      - Bot Creation and Ownership: beginner/bot-creation.md
      - AI Permissions and Questions: beginner/permissions-questions.md
  - Advanced Guide:
      - Quick Start and Modes: advanced/quick-start-and-modes.md
      - Voice (Piper TTS): advanced/voice.md
      - Movement and Navigation: advanced/movement-navigation.md
      - Appearance and Wearables: advanced/appearance.md
      - Building and Environment: advanced/building-environment.md
      - Content (Mesh Upload): advanced/content.md
      - Land Management: advanced/land.md
      - Social, Groups, and Session Control: advanced/social.md
      - Bot Creation and Spawner API: advanced/bot-creation.md
      - Server Maintenance and User Management: advanced/server-maintenance-user-management.md
      - AI Configuration: advanced/ai-configuration.md
      - Hardening: advanced/hardening.md
  - Reference:
      - Architecture Diagram: reference/architecture.md
      - Components: reference/components.md
      - Curated Top Commands: reference/top-commands.md
      - Glossary: reference/glossary.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

extra_css:
  - stylesheets/neon.css

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  - javascripts/mermaid.js