docs.pyserve.org
This repository contains the source files for the documentation of the PyServe project, which can be found at 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:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Page Title - pyserve</title>
<link rel="stylesheet" href="../style.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div id="container">
<div id="header">
<h1>pyserve</h1>
<div class="tagline">python application orchestrator</div>
</div>
<div class="breadcrumb">
<a href="../index.html">Home</a> / <a href="index.html">Section</a> / Page
</div>
<div id="content">
<!-- Page content here -->
</div>
</div>
</body>
</html>
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(orindex.htmlfrom 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:
<pre><code class="language-yaml">
server:
host: 0.0.0.0
port: 8080
</code></pre>
Supported languages:
language-yaml— YAML configuration fileslanguage-bash— Shell commands and scriptslanguage-python— Python code exampleslanguage-plaintext— Plain text output
Deployment
Documentation is deployed via Gitea Actions (see .gitea/workflows/deploy.yml)