Skip to Content
DocumentationFolder StructurePages

Pages

Page files are used to write the actual documentation text for projects.

Page types

There are two types of pages available on the wiki, both of which can be used at the same time.

grass_block Content pages

  • Found under the “Content” tab on the Wiki

  • Traditional wiki style 

  • No reading order

  • Recommended for all in-game content, such as blocks, items, entities etc.

Content pages allow you to interactively reference in-game content and provide a broader set of components you can use.

book Documentation pages

  • Found under the “Documentation” tab on the Wiki

  • Contain guide-like documentation similar to this website you’re browsing right now

  • Implied reading order

  • Recommended for guides and API / developer documentation

Metadata

Markdown page metadata, also known as simply Frontmatter, are used by the wiki to provide additional information about a page or in-game content. It’s located at the very beginning of each file in YAML format.

Below is an example of available frontmatter attributes for all pages types.

--- # History of changes to the page's content or documented item # (Optional) history: # Detailed entry with multiple changes and date - version: 1.2b date: 15.08.2025 changes: - Bugfixes - Add more data generation # Simple entry with version number and single change - 1.1: Fix custom ingredient implementation - 1.0: Added --- # Hello World Documentation content comes here

Each page type comes with its own set of available frontmatter attributes, which are further explained on their respective pages.

For details on the history attribute, read below.

Custom components

See the Components page.

Changelog

A changelog acts as a list of changes that have been made to the page’s subject under the history frontmatter attribute.

It is displayed at the bottom of the page as a collapsible element for content pages or as a switchable tab in the page title for documentation pages.

Format

There are 2 ways changelog entries can be written:

1) Simplified

A key-value pair where the key represents the version number and the value is a description of changes made.

- 5.6: Fixed spacebar overheating

2) Detailed

The detailed syntax allows you to specify a date and multiple changes in a single version.

- version: 1.2b date: 15.08.2025 changes: - Example change - Add more data generation

Example

history: # Detailed entry - version: 1.2b date: 15.08.2025 changes: - Example change - Add more data generation # Simple entries - 1.1: Some random change - 1.0: Added
Last updated on