Folder Structure Overview

Wiki projects follow a folder structure similar to the one you would find in the game’s own Resource Packs  or Data Packs .

We took some inspiration to make it easier for authors who are already experienced in making mods or modpacks to learn this format, and also because it requires few to no steps to reuse mod content.

This page gives a basic overview of the folder structure, whereas each of the features is described in more detail on their own page within this category.

Essentials

The very basic files you’ll need to write documentation are the wiki metadata file, folder metadata files and documentation pages.

sinytra-wiki.json

This file acts as the “heart” of the documentation package. It carries basic identifying information about the project as well as additional metadata that can be used to display information to users.

Check the Wiki Metadata page for details.

_meta.json

Can be placed in the root folder as well as each subfolder. Provides display names for files and folders, which are shown in the documentation navigation sidebar on the wiki, and also specifies the order in which they are displayed.

If not provided, fallback display names are generated automatically.

Check the Folder Metadata page for details.

Page files (*.mdx)

Page files contain documentation contents in an extended Markdown format.

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

Content pages

• Traditional wiki style 

• No reading order

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

Documentation pages

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

• Implied reading order

• Recommended for guides and API / developer documentation

Check the Pages page for complete details.

Features

See each page below for detailed explanations of available features:

• Homepage (_homepage.mdx) - Define a custom landing page for your documentation pages
• Assets (.assets) - Add images and other assets to your wiki
• Content Pages (.content) - Document in-game content
• Game Data (.data) - Seamlessly import in-game recipes, tags and other game content
• Translations (.translated) - Go international with translated wiki pages

Complete example

Below is a complete example of the Wiki folder structure using all supported features.

• .assets
• .content
• .data
• .translated
• getting_started
• _meta.json
• _homepage.mdx
• introduction.mdx
• sinytra-wiki.json