platform/mkdocs.yml at main · towlion/platform · 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
site_name: Towlion Platform
site_description: Self-hosted GitHub-native micro-PaaS for deploying small web applications
site_url: https://towlion.github.io/platform
repo_url: https://github.com/towlion/platform
repo_name: towlion/platform

theme:
  name: material
  custom_dir: overrides
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.copy
  palette:
    scheme: slate
    primary: custom
    accent: custom
  font:
    text: IBM Plex Sans
    code: JetBrains Mono

extra:
  homepage: https://towlion.github.io/

extra_css:
  - stylesheets/custom.css

plugins:
  - search
  - with-pdf:
      cover_title: Towlion Platform
      cover_subtitle: Documentation
      output_path: pdf/towlion-platform.pdf

nav:
  - Getting Started:
      - Home: index.md
      - Scope: scope.md
      - Tutorial: tutorial.md
  - Architecture:
      - Overview: architecture.md
      - App Specification: spec.md
      - Server Contract: server-contract.md
  - Deployment:
      - Pipeline: deployment.md
      - Self-Hosting: self-hosting.md
      - Preview Environments: preview-environments.md
      - Deploy Prompt: deploy-prompt.md
      - Self-Hosted Runners: self-hosted-runners.md
  - Operations:
      - CLI Reference: cli.md
      - Secrets Reference: secrets.md
      - Observability: observability.md
      - Troubleshooting: troubleshooting.md
      - Runbooks:
          - Restart App: runbooks/restart-app.md
          - Add New App: runbooks/add-new-app.md
          - Rotate Credentials: runbooks/rotate-credentials.md
          - Restore Backup: runbooks/restore-backup.md
          - Debug Failed Deploy: runbooks/debug-failed-deploy.md
  - Project:
      - Ecosystem: ecosystem.md
      - Governance: governance.md
      - Onboarding: onboarding.md
      - Decisions:
          - GitHub as Control Plane: decisions/001-github-as-control-plane.md
          - Caddy Over Nginx: decisions/002-caddy-over-nginx.md
          - Single-Server Architecture: decisions/003-single-server-architecture.md
          - Fork-Based Self-Hosting: decisions/004-fork-based-self-hosting.md
          - AppArmor Over SELinux: decisions/005-apparmor-over-selinux.md

markdown_extensions:
  - tables
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - attr_list
  - md_in_html