PropFlow-API/mkdocs.yml at master · HoseaCodes/PropFlow-API · 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
site_name: PropFlow API
site_description: Engineering documentation for the PropFlow API
site_url: https://hoseacodes.github.io/PropFlow-API/
repo_url: https://github.com/HoseaCodes/PropFlow-API
repo_name: HoseaCodes/PropFlow-API
edit_uri: edit/master/docs/

# Published to GitHub Pages by .github/workflows/docs.yml. The output is plain
# static files, so any static host would serve it -- but the build needs Docker,
# because the OpenAPI spec is generated by an integration test. That rules out
# hosts whose build images lack it.

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle: {icon: material/weather-night, name: Switch to dark mode}
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle: {icon: material/weather-sunny, name: Switch to light mode}
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.suggest
    - toc.follow

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc: {permalink: true}
  - pymdownx.details
  - pymdownx.highlight: {anchor_linenums: true}
  - pymdownx.inlinehilite
  - pymdownx.snippets
  # Renders ```mermaid blocks. Material ships the integration; without this the
  # architecture and ER diagrams would render as unstyled code blocks.
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search

nav:
  - Overview: index.md
  - Architecture: ARCHITECTURE.md
  - Security: SECURITY.md
  - Operations: OPERATIONS.md
  - API reference: api/index.html
  - Decision records:
      - Overview: adr/README.md
      - 001 · PostgreSQL: adr/ADR-001-postgresql.md
      - 002 · JWT authentication: adr/ADR-002-jwt-authentication.md
      - 003 · Flyway migrations: adr/ADR-003-flyway-migrations.md
      - 004 · Testcontainers: adr/ADR-004-testcontainers.md
      - 005 · Single deployable: adr/ADR-005-modular-monolith.md
      - 006 · NUMERIC money: adr/ADR-006-numeric-money.md

# Deliberately absent from the nav: ENGINEERING_AUDIT.md,
# PORTFOLIO_HARDENING_PLAN.md and INTERVIEW_GUIDE.md. They are still built and
# still reachable from the links that point at them, but they are process
# artefacts rather than API documentation, so they do not earn a nav slot.
not_in_nav: |
  ENGINEERING_AUDIT.md
  PORTFOLIO_HARDENING_PLAN.md
  INTERVIEW_GUIDE.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/HoseaCodes/PropFlow-API