Skip to Content
DocumentationFolder StructurePagesContent pages

Content pages

Content pages follow a traditional wiki layout , and are intended to describe in-game content, such as items, block, entities and others.

grass_blockfurnacediamond_pickaxeiron_ingotexperience_bottlepiglin_head

Their key feature is that they can display in-game data on the website in a highly intuitive manner. This namely includes item/block properties, recipes (both vanilla and custom), crafting usage and other data.

On the Wiki website, these are located under the project’s “Content” tab.

Placement

Content pages are all placed inside the content folder within the project.

They must be further nested at least by a single level to “shallow” cateogories, and can be further nested by another level to create “deep” categories.

        • _meta.json
        • sword.mdx
          • _meta.json
          • electric_furnace.mdx
        • _meta.json
      • _meta.json

Example

Below you can find a content page example from Modular Force Field Systems  describing the Force Field Projector machine.

It demonstrates the efficient use of content links, recipe obtaining/usage and changelogs in the page body.

---
id: mffs:projector
type: block
history:
  - 1.1: Reduced energy usage by 5%
  - 1.0: Added
---
 
# Force Field Projector
 
The Force Field Projector is a fundamental part of the MFFS family of machines.
It uses []($fortron) energy to project force fields of various shapes and sizes
into the world.
 
{/* Shows recipes for this block */}
<PrefabObtaining />
 
## Operation
 
To make a force field, give the Force Field Projector a supply of []($fortron)
by linking it to a nearby [](@mffs:fortron_capacitor).
 
Decide which force field shape to create by crafting one of the projector mode
items.
Right-click the Projector and place the projector mode item into the central (red)
slot surrounded by outwardly facing arrows.
 
Craft a number of [Scale Modules](@mffs:scale_module) and place them into the
left-hand slot matrix of the Force Field Projector's GUI.
Each [](@mffs:scale_module) used in the Projector's matrix slots will increase
the force field radius by one block.
 
To be able to walk through a force field, a [](@mffs:biometric_identifier)
is required.
 
## Upgradability
 
A Force Field Projector may be augmented with various modules.
 
These general modules have the following effects:
 
- [](@mffs:scale_module): Adjusts the shape of a projected force field
- [](@mffs:speed_module): Allows the Projector to generate a force field
  more quickly
- [](@mffs:capacity_module): Increases the amount of Fortron the Projector
  is able to store
 
{/* Shows usage of this block in recipes */}
<PrefabUsage />

Authoring

Content pages are traditionally focused on describing a specific object rather than providing broader tutorials. These descriptions often include technical information, such as IDs, stats and relations.

This is where the Wiki becomes a huge helper. It saves you time doing the boring work of copy-pasting reference values from the game and gives you the ability to reuse locales, recipes, tags and other data files from your project to be displayed in content pages, allowing you to focus on writing what’s important.

When writing content pages, we encourage you to take full advantage of helper components offered by the wiki and automate copying/generating data files in the project.

Checklist

Content pages use a broader context which may not always be clear. Below a general list of things to keep in mind when authoring documentation. It also shows how in-game data files are referenced by content pages and by extent, interactive components.

Advice for writing top-notch content pages:

  • Easily link to other pages

  • Include your item’s name in a Language File to be displayed in recipes and tags

  • Add Obtaining and Usage to show how your item can be crafted and used in other recipes

  • Add a Changelog to inform users of past changes

Metadata

Make sure to always specify the id attribute for content pages!

Content pages must always specify the id frontmatter attribute, which is used to link the page to in-game content. This is crucial for interacting with game data files in the project.

By default, for single-item pages, the ID doubles as the location of the page icon, which is sourced from assets.

---
# Specify one or multiple IDs of items documented on this page
# (Required)
id: examplemod:generator
# For multi-item pages, you can specify a list of IDs:
id:
  - examplemod:red_cable
  - examplemod:blue_cable
---

Extended metadata

There’s several optional attributes you can specify to fully customize your page. However, in most cases, the wiki will fill in the best defaults available.

View extended metdata example

---
# ============ Everything below is optional! ============
# Specify optional properties only where necessary,
# let the wiki pick default values for you.
# =======================================================
 
# Specify a custom ref used to navigate to this page.
# Must be unique for all content pages. The Wiki will assign one by default.
# (Optional)
ref: colored_cables
 
# An asset resource location that will be displayed as the page's icon in the
# project content index.
# Single-item pages: will also be used in the infobox body as the preview image
# (Optional)
icon: examplemod:item/yellow_cable
 
# Type of the documented item(s). Will be displayed under properties.
# Currently, this is purely cosmetical.
# Can be 'block', 'item' or 'other'.
# (Optional)
type: block
 
# Additional properties to display.
# Map of string -> string
# (Optional)
custom:
  Subcategory: Wiring
 
# Configure the infobox element shown in the page's right panel
# (Optional)
infobox:
  # Title to show on top of infobox (default: page title)
  # (Optional)
  title: Cables
 
  # Single tab body (specify either this OR 'tabs', never both)
  # (Optional)
  display:
    - examplemod:item/yellow_cable
 
  # Infobox tabs (item variants)
  # (Optional)
  tabs:
      # Tab (item variant) name
    - name: Yellow
      # Asset locations to show in large (single item or list)
      display: examplemod:item/yellow_cable
      # --- OR ---
      display:
        - examplemod:item/yellow_cable
        - examplemod:item/yellow_cable_cut
 
    - name: Orange
      display: examplemod:orange_cable
 
  # Inventory slots to show (single item or list of asset locations)
  # (Optional)
  inventory:
    - examplemod:item/yellow_cable
    - examplemod:item/orange_cable
 
# Changelog. See parent page for details
# (Optional)
history: ...
---

Sideabar

Content pages contain a sidebar that displays various properties and stats about in-game items, which are sourced from the Item Properties file. Additional properties can be specified in the frontmatter - see custom attribute under Extended metadata.

To customize the displayed item assets and inventory slots, see the infobox attribute.

Interaction

Content pages allow you to make excellent use of dynamic components provided by the Wiki, which use project game files behind the scenes to display information.

Read the Game Data page to learn more about how you can easily include game data files in your Wiki project.

Last updated on
PagesDocumentation pages