Skip to content

Commit 74811c9

Browse files
committed
feat: add readme and license
1 parent 6920c8c commit 74811c9

2 files changed

Lines changed: 87 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025-2026 Brainpod
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Brainpod Docs
2+
3+
The documentation site for [Brainpod](https://brainpod.io), published at [docs.brainpod.io](https://docs.brainpod.io).
4+
5+
Built with [Lume](https://lume.land) and the [simple-wiki](https://github.com/lumeland/theme-simple-wiki) theme.
6+
7+
## Development
8+
9+
Requires [Deno](https://deno.land).
10+
11+
```bash
12+
deno task serve
13+
```
14+
15+
The site will be available at `http://localhost:3000` with hot reload.
16+
17+
## Build
18+
19+
```bash
20+
deno task build
21+
```
22+
23+
Output is written to `./_site`.
24+
25+
## Structure
26+
27+
```
28+
src/
29+
├── index.md # Homepage
30+
├── getting-started.md # Getting started guide
31+
├── brainpod.md # Core concepts
32+
├── background-information.md # Cloud-native background
33+
├── resources.md # Resources overview
34+
├── resources/
35+
│ ├── apps.md # Apps resource
36+
│ ├── routes.md # Routes resource
37+
│ ├── disks.md # Disks resource
38+
│ ├── config.md # Config resource
39+
│ ├── postgres.md # PostgresDB resource
40+
│ ├── mariadb.md # MariaDB resource
41+
│ └── valkey.md # Valkey resource
42+
├── blueprints.md # Blueprints overview
43+
├── blueprints/
44+
│ ├── wordpress.md # WordPress blueprint
45+
│ ├── pocketbase.md # PocketBase blueprint
46+
│ └── nextjs.md # Next.js blueprint
47+
├── custom_domains.md # Custom domains
48+
└── registry.md # Container registry
49+
```
50+
51+
## Adding a Page
52+
53+
Create a new `.md` file in the appropriate directory and add frontmatter:
54+
55+
```yaml
56+
---
57+
order: 5 # Controls position in the sidebar
58+
hide_menu: false
59+
metas:
60+
description: "Page description for search engines."
61+
keywords: ["keyword one", "keyword two"]
62+
---
63+
# Page Title
64+
```
65+
66+
Pages inside a subdirectory (e.g. `resources/`) automatically appear nested under their parent in the sidebar.

0 commit comments

Comments
 (0)