The Deploy Pipeline from Source to Live Site

flowchart LR S1[Markdown Source\ndocs/ + mkdocs.yml]:::blue -->|source files| S2[MkDocs Build\nmkdocs build\nProduces site/ HTML]:::blue S2 -->|built site| S3[Git Commit + Push\nto main branch]:::blue S3 -->|triggers deploy| S4[mkdocs gh-deploy\nPushes to gh-pages]:::blue S4 -->|published| S5[GitHub Pages\nPublic URL served]:::blue S5 -.->|reader feedback| S1 F1[F1: Build Error\nMissing plugin,\nmalformed front matter]:::fail --- S2 F2[F2: Broken Link\nRelative path mismatch,\nrenamed chapter]:::fail --- S2 F3[F3: Deploy Cache Drift\nStale assets from\nCDN TTL or filename]:::fail --- S4 F3b[F3 also affects]:::fail --- S5 classDef blue fill:#4A90D9,stroke:#2C5F8A,color:#fff classDef fail fill:#FFCDD2,stroke:#E53935,color:#B71C1C

Back to Documentation