pantstack/mkdocs.yml at main · MehdiZare/pantstack · 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: Pantstack Template
site_description: Batteries-included monorepo template with Pants, Pulumi, FastAPI, and GitHub Actions
site_author: MehdiZare
site_url: https://mehdizare.github.io/pantstack/
repo_name: MehdiZare/pantstack
repo_url: https://github.com/MehdiZare/pantstack
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

plugins:
  - search

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.emoji
  - admonition
  - codehilite
  - meta
  - toc:
      permalink: true
  - tables
  - attr_list
  - md_in_html

nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: getting-started/quick-start.md
    - Template Setup: getting-started/template-setup.md
    - Creating Projects: getting-started/creating-projects.md
    - Setup Checklist: getting-started/setup-checklist.md
  - Architecture:
    - Overview: architecture/overview.md
    - Module Structure: architecture/modules.md
    - Infrastructure: architecture/infrastructure.md
    - CI/CD Pipeline: architecture/cicd.md
  - Development:
    - Commands: development/commands.md
    - Module Development: development/module-development.md
    - Testing: development/testing.md
    - Versioning: development/versioning.md
  - Template Maintenance:
    - Publishing: template/publishing.md
    - Updating: template/updating.md
    - Contributing: template/contributing.md
  - Reference:
    - Claude Instructions: reference/claude.md
    - API Reference: reference/api.md
    - Configuration: reference/configuration.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/MehdiZare/pantstack