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.

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.

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

Format

The wiki uses MDX  files as its documentation format. In additon, GitHub Flavored Markdown  (GFM) is also available using remark-gfm.

If you’re not yet familiar with MDX, don’t worry - it is an extension of the simple Markdown  format with added JSX capabilities, meaning you can include fancy custom components in your documentation, such as crafting recipes.

These features are purely optional, and you can always stick to using standard Markdown in your documentation. However, the file extension must remain .mdx.

Extensions

We provide a few useful markdown extensions that can be used as syntax sugar.

Asset images

Display any asset image using native markdown syntax by specifying the asset location prefixed with @.

For example:

<!-- Will display: <root>/assets/examplemod/generator.png -->
![](@examplemod:generator)

Content page links

To link to an item’s content page, use the ID of the item you want to link, prefixed with @. The wiki will automatically find the most fitting content page that includes this item and substitute the link url.

For example:

<!-- Uses page title as link text -->
[](@examplemod:electric_furnace)
 
<!-- Uses custom link text -->
Click [here](@examplemod:electric_furnace) to learn more.

You can also link to content pages directly using the page’s reference prefixed with a +. This is a unique identifier that appears in the URL when you browse the page. The wiki creates it for you by default, but you can specify a custom one using the ref frontmatter attribute.

<!-- Uses page title as link text -->
[](+pickaxes)
 
<!-- Uses custom link text -->
Click [here](+colored_cables) to learn more.

Documentation page links

To link to Documentation pages, use the path of the page you want to link to (relative to the project root), prefixed with $.

For example:

<!-- Uses page title as link text -->
[]($tutorials/getting_started)
 
<!-- Uses custom link text -->
Click [here]($tutorials/getting_started) to read the first tutorial.

Limitations

Because MDX can potentially allow unwanted code injection on the server, we sanitize all sources before they’re rendered, which can result in certain features of MDX being unavailable. That said, if there’s a safe feature you’d like to use in your documentation that isn’t available on the wiki, please open an issue on our GitHub repository .

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