Basalt Documentation

The documentation published at basaltmc.org/docs.

Overview

This repository holds the content. The site that renders it lives in Website and pulls this repository in as a submodule.

Layout

<section>/<order>-<slug>.mdx

<section> is a directory and matches a section registered in the site. The numeric prefix orders pages within a section and is stripped from the URL, so server/02-installation.mdx is served at /docs/server/installation.

Page format

Every page opens with a front matter head:

---
title: Installation
description: One sentence, shown under the title and in search results.
group: Configuration
---

group is optional: consecutive pages with the same group sit under one heading in the sidebar.

The body is markdown. It can also use components, which is what the .mdx extension is for:

<x-docs.callout type="warning" title="Before you start">
Accept the EULA first. The server writes `eula.toml` and stops on first start.
</x-docs.callout>

type is note, tip or warning. The body of a callout is markdown too.

Fenced code blocks are highlighted. Tag them with a language so they are: lua, bash, toml.

Editing

Pages are plain files: edit them here, commit, and the site picks them up on its next deploy. Adding a page is adding a file. Adding a section needs a matching entry on the site side.