Getting Started

Getting Started

This page shows the smallest useful GuideNH runtime guide layout and the first page you can author.

Minimum Runtime Layout

wiki/resourcepack/
`-- assets/
    `-- <modid>/
        `-- guidenh/
            |-- assets/
            |   `-- example_structure.snbt
            `-- _en_us/
                `-- index.md

For the built-in example guide in this repository, that resolves to:

wiki/resourcepack/assets/guidenh/guidenh/

Guide Discovery

GuideNH now discovers pages directly from the resource tree. Any markdown file under assets/<modid>/guidenh/_<lang>/... is part of the guide for <modid>:guidenh. index.md is still the conventional start page and the recommended place to begin.

Each <modid> gets its own isolated guide namespace. For example, assets/guidenh/guidenh/_en_us/index.md and assets/gregtech/guidenh/_en_us/index.md are two different pages in two different guides: guidenh:guidenh and gregtech:guidenh. Relative links such as [Next](guide.md) stay inside the page's own namespace; write an explicit id such as [GT Page](gregtech:guide.md) when you want to cross to another mod's guide. Rooted explicit paths like gregtech:/guide.md are also accepted.

Fast Local Iteration

If you are editing the built-in example guide in this repository, prefer the live preview workflow documented in Live Preview.

That workflow points GuideNH at:

wiki/resourcepack/assets/guidenh/guidenh/

and opens the guide automatically on startup.

First Page

---
navigation:
  title: Root
---

# Start Page

Welcome to GuideNH.

[Next Page](subpage.md)

Adding Navigation Metadata

The smallest useful frontmatter for navigation is:

navigation:
  title: Root

Without navigation frontmatter, the page can still exist and be linked to directly, but it will not automatically appear in the guide navigation tree.

If you also want a page to appear in the home page Recommended panel, add navigation.recommend. The field is optional, 0 is valid, and larger values appear earlier.

Adding Assets

Place page-local assets next to the page file:

wiki/resourcepack/assets/guidenh/guidenh/_en_us/test1.png

Reference them relatively from markdown:

![Example](test1.png)

Place shared guide assets under the guide's own assets/ folder:

wiki/resourcepack/assets/guidenh/guidenh/assets/example_structure.snbt

Reference them with a rooted guide path:

<ImportStructure src="/assets/example_structure.snbt" />

Next Steps

• Live Preview
• Guide Page Format
• Navigation
• Images And Assets
• Tags Reference