This repository contains all markdown content for downpatch.com. The application pulls this repo directly and renders the pages at runtime.
The goal of this repo is:
- Keep content fully open source
- Keep structure simple
- Make guides easy to edit
- Avoid hidden logic inside the app
The k3s deployment runs the application in Kubernetes. The content repository is:
- Cloned on container startup
- Refreshed hourly
This means:
- Pushing to
mainhere will go live on the hour.
All guides live under:
guide/
Example:
guide/
halo/
index.md
toc.yml
haloreach/
index.md
levels.md
Rules:
- Every folder must contain an
index.md - Nested folders are allowed
- URLs are based on folder structure
index.mdbecomes the folder root page
Each markdown file must start with YAML frontmatter.
Recommended fields:
---
title: Halo: Reach
nav_title: Halo: Reach
description: Getting started with Halo Reach speedrunning.
square_image: square.webp
og_image: og.webp
leaderboard: https://haloruns.com
discord: https://haloruns.com/discord
noindex: false
---Field explanation:
title— Main page titlenav_title— Optional shorter title for sidebardescription— Used for meta description + preview textsquare_image— Used on the game search pageog_image— Used for social previewsleaderboard— Optional external linkdiscord— Optional external linknoindex— If true, page will not appear in sitemap
Each folder can define its navigation using a toc.yml.
Example:
- name: "Overview"
href: index.md
- name: "Livesplit"
href: livesplit.md
- name: Games
items:
- name: "Halo: Combat Evolved"
href: haloce/index.md
- name: "Halo 2"
href: halo2/index.md
- name: "Halo 3: ODST"
href: halo3odst/index.mdRules:
name— Display text in sidebar (Value must be in quotations)href— Relative path to markdown fileitems— Nested navigation group- Indentation must use spaces (not tabs)
If no toc.yml exists, the folder will still work, but navigation will be limited.
/guide/folder/index.mdbecomes/guide/folderin the application- Nested
/guide/folder/subfolder/index.mdbecomes/guide/folder/subfolder - Other files become
/guide/folder/file
Example:
guide/halo/index.md → /guide/halo
guide/halo/haloreach/index.md → /guide/halo/haloreach
guide/halo/haloreach/levels.md → /guide/halo/haloreach/levels
Content is intentionally simple:
- No database
- No CMS
- No hidden admin system
If something is wrong, open a PR.