Writing a resource sheet

How to add or edit a page in these docs.

Last recorded
Sep 9, 2026

The docs are Markdown files under content/docs in the site's source. Add a file and it appears in the index on the next build; there is nothing else to register.

Files and URLs

text
content/docs/
├── index.md                              → /docs
├── 1.getting-started/
│   ├── .navigation.yml                   → names the section
│   └── 1.installation.md                 → /docs/getting-started/installation
└── 3.resources/
    └── 1.blackwater-house-1.md           → /docs/resources/blackwater-house-1

The number and dot at the front of a folder or file name only set the order; they are stripped from the URL.

Front matter

Every page starts with a block like this:

yaml
---
title: "Blackwater House #1"
description: One sentence shown under the title and in search results.
platform: RedM
updated: 2026-09-09
---

title and description are required; quote a title that contains # or :. platform is shown on resource sheets; updated is shown as "Last recorded".

Callouts

md
::callout{type="note"}
Something worth knowing.
::

The type can be note, tip or warning.

Code

Fenced code blocks are highlighted. Name the language after the opening fence, and add a filename to show it on the block:

md
```lua [config.lua]
Config.Framework = 'auto' -- 'auto' | 'qbcore' | 'esx' | 'standalone'
```

Headings

Use ## for the sections of a page and ### inside them. Both appear in the "On this sheet" list beside the article.