TheSourceInstaller/mkdocs.yml at main · PanterSoft/TheSourceInstaller · 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
97
98
99
site_name: TSI Documentation
site_description: The Source Installer - Distribution-independent source-based package manager
site_url: https://pantersoft.github.io/TheSourceInstaller/
repo_url: https://github.com/PanterSoft/TheSourceInstaller
repo_name: PanterSoft/TheSourceInstaller
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  # "custom" hands the colors to docs/stylesheets/tsi.css (Forge Red palette,
  # see docs/brand.md).
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.annotate
    - content.code.copy

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Usage: getting-started/usage.md
  - User Guide:
    - Package Management: user-guide/package-management.md
    - Package Format: user-guide/package-format.md
    - External Packages: user-guide/external-packages.md
    - Version Discovery: user-guide/version-discovery.md
    - Strict Isolation: user-guide/strict-isolation.md
  - Developer Guide:
    - Architecture: developer-guide/architecture.md
    - Testing: developer-guide/testing.md
    - OS-Specific Config: developer-guide/os-specific-config.md
    - Repository: developer-guide/repository.md
    - Maintenance: developer-guide/maintenance.md
    - Documentation Deployment: DEPLOYMENT.md
  - Workflows:
    - Automation: workflows/automation.md
    - Version Discovery: workflows/version-discovery.md
    - External Packages: workflows/external-packages.md
    - Permissions: workflows/permissions.md
    - Triggers: workflows/triggers.md
    - Trigger Workflow: workflows/trigger-workflow.md
  - Reference:
    - CLI Reference: reference/cli-reference.md
    - Package Repository: reference/package-repository.md
    - Basic Packages: Basic_Packages.md
    - Scripts: reference/scripts.md
    - Bootstrap Options: reference/bootstrap-options.md
    - Brand & Colors: brand.md

extra_css:
  - stylesheets/tsi.css

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true

# Exclude README.md from build (conflicts with index.md)
exclude_docs: |
  README.md

extra:
  version:
    provider: mike