Path-Header-Scanner/mkdocs.yml at main · devalltect00/Path-Header-Scanner · 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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
site_name: ⛶ Path Header Scanner
site_description: Developer utility for inserting, validating, and updating file path headers across source code and documentation files.
# site_url: https://mydomainsite.com
site_url: http://localhost:8001
site_author: Devalltect00

repo_name: path-header-scanner
repo_url: https://github.com/devalltect00/Path-Header-Scanner

#gitlab
# edit_uri: -/edit/main/backend/docs
#github
# edit_uri: edit/main/docs/

theme:
    name: material
    language: en
    palette:
        - media: "(prefers-color-scheme: light)"
          scheme: default
          primary: purple
          accent: deep purple
          toggle:
              icon: material/weather-night
              name: Switch to dark mode
        - media: "(prefers-color-scheme: dark)"
          scheme: slate
          primary: teal
          accent: lime
          toggle:
              icon: material/weather-sunny
              name: Switch to light mode
    font:
        text: Roboto
        code: Fira Code
    icon:
        logo: fontawesome/solid/d
    features:
        - navigation.instant
        - navigation.tracking
        - navigation.tabs
        - navigation.sections
        - navigation.expand
        - navigation.footer
        - navigation.top
        - toc.integrate
        - header.autohide
        - content.code.annotate
        - content.code.copy
        - content.tabs.link
        - search.suggest
        - search.highlight

markdown_extensions:
    - admonition
    - attr_list
    - def_list
    - footnotes
    - codehilite
    - md_in_html
    - tables

    - toc:
          permalink: true

    - pymdownx.keys
    - pymdownx.tasklist
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences
    - pymdownx.details
    - pymdownx.tabbed:
          alternate_style: true
    - pymdownx.highlight:
          anchor_linenums: true
          line_spans: __span
          pygments_lang_class: true
    # - pymdownx.emoji
    # Local (run well)
    - pymdownx.emoji:
          emoji_index: !!python/name:material.extensions.emoji.twemoji
          emoji_generator: !!python/name:material.extensions.emoji.to_svg
              # (wwhen build for production)
              # - pymdownx.emoji:
              # emoji_index: !!python/name:material.extensions.emoji.twemoji
              # emoji_generator: !!python/name:material.extensions.emoji.to_svg


plugins:
    - search:
          lang: en

docs_dir: docs
site_dir: site

nav:
    - 🏠 Home:
          - 🔎 Overview: index.md

    - 👤 User Guide:
          - How To Use: how-to-use.md
          - Overview: user-guide/overview.md
          - Quick Start: user-guide/quickstart.md
          - Commands: user-guide/commands.md
          - Dry-run Safety: dry-run.md
          - Installation Methods: user-guide/installation-methods.md
          - Lifecycle (Start/Run/Stop/Remove): user-guide/lifecycle.md
          - Legacy Overview (Reference): user-guide/legacy-overview.md
          - Legacy User Guide (Reference): user-guide/legacy-user-guide.md

    - 🧑‍💻 Developer Guide:
          - Getting Started: developer-guide/getting-started.md
          - Developer Guide (Reference): developer-guide/developer-guide.md
          - Make Workflow: developer-guide/make-workflow.md
          - Docker Workflow: developer-guide/docker-workflow.md
          - AI Development Workflow: developer-guide/blackbox/ai-development-workflow.md
          - Tooling:
                - Ruff Ignore Rules: developer-guide/tooling/ruff/ruff-ignore.md
                - Ruff Select Rules: developer-guide/tooling/ruff/ruff-select.md

    - 🏗 Architecture:
          - Design Patterns: architecture/design-patterns.md
          - Workflow: architecture/workflow.md
          - Diagrams: architecture/diagrams.md

    - 🧪 Testing:
          - Testing Guide: testing/testing-guide.md

    - 🗺 Project:
          - Project Structure: project/project-structure.md
          - Supported Languages: project/languages/supported-languages.md
          - Markdown Language Strategy: project/languages/markdown-language-strategy.md

    - 📖 Reads:
          - Documentation Audit Report: reads/documentation-audit-report.md
          - Linting vs Formatting: reads/linting-vs-formatting.md
          - Ruff: reads/ruff.md

    - 📌 Core Docs:
          - Badges: badges.md
          - Installation: installation.md
          - Usage: usage.md
          - Configuration: configuration.md
          - Infrastructure: infrastructure.md
          - CI/CD: ci-cd.md
          - TODO Tracking History: TODO_tracking_history.md

extra:
    generator: false
    social:
        - icon: material/linkedin
          link: https://www.linkedin.com/in/rizky-purwanto-fernandes/
        - icon: simple/github
          link: https://github.com/devalltect00
        - icon: octicons/globe-24
          link: https://personal-portfolio-devalltect00.vercel.app/

extra_css:
    - stylesheets/extra.css

copyright: Copyright &copy; 2026 Devalltect

# Reference
# - https://squidfunk.github.io/mkdocs-material/
# - https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
# - https://pygments.org/docs/lexers/