Brainpod Docs

The documentation site for Brainpod, published at docs.brainpod.io.

Built with Lume and the simple-wiki theme.

Development

Requires Deno.

deno task serve

The site will be available at http://localhost:3000 with hot reload.

Build

deno task build

Output is written to ./_site.

Structure

src/
├── index.md # Homepage
├── getting-started.md # Getting started guide
├── brainpod.md # Core concepts
├── background-information.md # Cloud-native background
├── resources.md # Resources overview
├── resources/
│ ├── apps.md # Apps resource
│ ├── routes.md # Routes resource
│ ├── disks.md # Disks resource
│ ├── config.md # Config resource
│ ├── postgres.md # PostgresDB resource
│ ├── mariadb.md # MariaDB resource
│ └── valkey.md # Valkey resource
├── blueprints.md # Blueprints overview
├── blueprints/
│ ├── wordpress.md # WordPress blueprint
│ ├── pocketbase.md # PocketBase blueprint
│ └── nextjs.md # Next.js blueprint
├── builds.md # Builds
├── custom_domains.md # Custom domains
└── registry.md # Container registry

Adding a Page

Create a new .md file in the appropriate directory and add frontmatter:

---
order: 5# Controls position in the sidebarhide_menu: falsemetas:
description: "Page description for search engines."keywords: ["keyword one", "keyword two"]
---
# Page Title

Pages inside a subdirectory (e.g. resources/) automatically appear nested under their parent in the sidebar.