Documentation pages

Documentation pages follow a guide-like layout (such as the documentation you’re reading right now) and are best suited for writing user guides, tutorials and developer documentation for your project.

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

Placement

Documentation pages can be arbitrarily named and nested inside the project. They must use the .mdx extension.

Folders created in the file tree will also show up as folders in the wiki documentation sidebar.

• <root>
  • docs
    • ...arbitrarily_nested_path
      • arbitrary_name.mdx
    • example_block.mdx

Example

Following is an example of a simple documentation page. Notice how an import is not required to use wiki components.

# Introduction
 
Introduction to Example Mod.
 
<Callout variant="info">
  This is a sample info callout
</Callout>
 
-- Your text comes here --
 
Now, have some *lorem ipsum*.
 
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam urna enim,
vestibulum non justo nec, euismod venenatis mauris. Curabitur metus massa,
aliquet non dapibus eget, porttitor eu lorem. Vestibulum et sagittis justo.
 
Integer a velit quis est auctor finibus. Vivamus libero lorem, vehicula eu
est ut, pellentesque dignissim enim. Integer iaculis turpis id neque eleifend
malesuada. Curabitur convallis ultrices orci. Phasellus imperdiet pulvinar
lacus, id luctus

Authoring

Documentation pages can make use of available frontmatter properties and all non-interactive components.

The Markdown format is shared across all types of pages.

Checklist

Here’s a basic list of things to keep in mind when writing documentation pages:

• Specify frontmatter properties as desired

• Create a folder metadata file to specify sidebar page/folder names

• Check out available components to include

Metadata

Documentation pages don’t have any required frontmatter attributes, but you may specify a few optional ones.

Example usage with explanations can be found below.

---
# Resource location of an asset that will be shown as the documented item's icon
# It should be at least 128x128 px in size
# (Optional)
icon: examplemod:item/fancy_generator
 
# Changelog. See parent page for details
# (Optional)
history: ...
---

Next steps

Once ready, preview your pages using our local previewer!