ruohki
4464774c7a
8 files: index.md with wiki-links, features overview, navigation guide, markdown showcase (all constructs), about page, changelog, and two guides (sysop handbook, writing content) in a subdirectory. Includes ANSI art splash.txt for the index page header.
70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
---
|
|
description: Tips for writing vault content
|
|
---
|
|
|
|
# Writing Content
|
|
|
|
Tips for creating great content for your BBS-MD vault.
|
|
|
|
## File Structure
|
|
|
|
Every `.md` file in your vault directory is a page. Subdirectories create sections:
|
|
|
|
```
|
|
vault/
|
|
index.md <- Landing page (always loads first)
|
|
splash.txt <- ANSI art header (optional)
|
|
features.md <- Top-level page
|
|
guides/
|
|
sysop-handbook.md
|
|
writing-content.md
|
|
```
|
|
|
|
## Frontmatter
|
|
|
|
Add YAML frontmatter to your pages for metadata:
|
|
|
|
```
|
|
---
|
|
description: A short summary shown in the directory listing
|
|
---
|
|
```
|
|
|
|
The `description` field appears beside your file in the [[Directory]] listing, helping visitors find what they're looking for.
|
|
|
|
## Linking Between Pages
|
|
|
|
### Wiki-Links (Recommended)
|
|
|
|
Use double-bracket syntax to link between pages:
|
|
|
|
- `[[Page Name]]` resolves to `page-name.md`
|
|
- Case-insensitive: `[[features]]` and `[[Features]]` both work
|
|
- Cross-directory: `[[SysOp Handbook]]` finds `guides/sysop-handbook.md`
|
|
|
|
### Standard Links
|
|
|
|
Standard markdown links work too:
|
|
|
|
- `[Click here](features.md)` — relative to vault root
|
|
- `[Guide](guides/sysop-handbook.md)` — path to subdirectory files
|
|
|
|
### Special Links
|
|
|
|
- `[[Directory]]` — opens the virtual directory listing page
|
|
|
|
## Best Practices
|
|
|
|
1. **Start with index.md** — it's your front door
|
|
2. **Use frontmatter descriptions** — they show up in the directory
|
|
3. **Link generously** — wiki-links make your vault navigable
|
|
4. **Keep files small** — one topic per page, like a real BBS
|
|
5. **Use all six heading levels** — they each have distinct styling
|
|
6. **Add a splash.txt** — ANSI art makes everything better
|
|
|
|
> A well-linked vault is a joy to browse. A pile of unlinked pages is a graveyard.
|
|
|
|
---
|
|
|
|
Back to [[index|home]] or browse the [[Directory]].
|