6 - GitHub Sync

Overview

If your documentation already lives on GitHub, you can sync it directly with your mod wiki. Changes pushed to your repository will automatically appear on the site — no manual updates needed.

Setting up

Go to your mod settings and scroll down to GitHub Repository URL. Paste your repository link and save.

If your documentation is inside a subfolder, set the path in Repository Path. If the entire repository is documentation, leave this field empty.

Repository structure

Your repository should contain .md files at the root of your documentation folder:

my-repo/
└── docs/
    ├── intro.md
    ├── installation.md
    └── usage.md

Each file becomes a page on your wiki. The filename (without .md) is used as the page slug.

Frontmatter

You can let our software know how you would like to configure and show your pages via the Frontmatter on all Markdown (.md) files. The Frontmatter must be at the very beginning of your files.

Here is a table of available fields:

Example

---
title: "Introduction"
order: 1
published: true
draft: false
---

# Introduction

Categorys and Hierarchy

If you want to make children pages under a page, you need to create a folder. If you want the parent page to have contents, you can make a file named index.md and put the content inside it. The rest of the pages in that folder will be children of the folder.

If you want to create a category and do not want content on the parent page, you can make a meta.json file which will let you modify the title of the category, etc.

Example

{
  "title": "My Category",
  "published": true
}

Updating documentation

Push changes to your repository as usual — the wiki will update automatically.

git add .
git commit -m "Update documentation"
git push