api-style-spec/mkdocs.yml at main · plexusone/api-style-spec · 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
site_name: api-style-spec
site_description: Machine-readable API style specification format
site_url: https://api-style-spec.dev
repo_url: https://github.com/plexusone/api-style-spec
repo_name: plexusone/api-style-spec

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    # Dark mode first (PlexusOne default)
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy

extra_css:
  - https://plexusone.dev/css/plexusone-mkdocs.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Guide:
      - Getting Started: guide/getting-started.md
      - Automated API Governance: guide/automated-api-governance.md
      - Using Profiles: guide/profiles.md
      - Custom Rules: guide/custom-rules.md
      - MCP Server: guide/mcp-server.md
  - Reference:
      - CLI Commands: reference/cli.md
      - Configuration File: reference/config.md
      - Specification Format: reference/schema.md
      - AI Assistant Hooks: reference/hooks.md
  - Profiles:
      - Default: profiles/default.md
      - Azure: profiles/azure.md
      - Google: profiles/google.md
      - Zalando: profiles/zalando.md
  - Design:
      - Constitution: specs/CONSTITUTION.md
      - MRD: specs/inception/MRD.md
      - PRD: specs/inception/PRD.md
      - TRD: specs/inception/TRD.md
      - Roadmap: specs/inception/ROADMAP.md
  - Releases:
      - Changelog: releases/changelog.md
      - v0.2.0: releases/v0.2.0.md
      - v0.1.0: releases/v0.1.0.md

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/plexusone/api-style-spec