# docs.pyserve.org This repository contains the source files for the documentation of the PyServe project, which can be found at [docs.pyserve.org](https://docs.pyserve.org). ## Structure ``` docs/ ├── index.html # Main documentation page ├── blog.html # Blog listing page ├── blog-post.html # Individual blog post template ├── style.css # Global styles with highlight.js integration ├── getting-started/ # Getting started guides │ ├── index.html │ ├── installation.html │ └── quickstart.html ├── guides/ # User guides │ ├── index.html │ ├── asgi-mount.html │ ├── configuration.html │ ├── process-orchestration.html │ ├── reverse-proxy.html │ └── routing.html ├── reference/ # API reference │ ├── index.html │ ├── asgi-mount.html │ ├── cli.html │ └── extensions.html └── scripts/ # JavaScript utilities ├── blog.js ├── blog-post.js └── version-fetcher.js ``` ## Standard Page Template All documentation pages follow this structure: ```html Page Title - pyserve
Home / Section / Page
``` ## Breadcrumb Navigation Format - Root pages: `Home / Section` - Subsection pages: `Home / Section / Page` - Always use `/` as separator - Link to parent section with `index.html` - Link to home with `../index.html` (or `index.html` from root) ## Code Highlighting All pages use highlight.js for automatic syntax highlighting: - **Theme**: `github-dark.min.css` (matches dark theme) - **Auto-initialization**: `hljs.highlightAll()` runs on page load - **Custom styles**: Enhanced color palette in `style.css` - **Languages detected**: YAML, Bash, Python, Plaintext ### Code Block Format All code blocks use semantic language classes: ```html 

server:
  host: 0.0.0.0
  port: 8080
``` Supported languages: - `language-yaml` — YAML configuration files - `language-bash` — Shell commands and scripts - `language-python` — Python code examples - `language-plaintext` — Plain text output ## Deployment Documentation is deployed via Gitea Actions (see `.gitea/workflows/deploy.yml`)