Getting Started zh CN

English

快速开始

本页展示一个最小但实用的 GuideNH 运行时指南目录结构，以及你可以编写的第一个页面。

最小运行时结构

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

对于本仓库内置的示例指南，对应路径是：

wiki/resourcepack/assets/guidenh/guidenh/

TXLoader 原生布局

如果通过 TXLoader 部署同一批文件，需要去掉外层 assets/ 目录，因为 TXLoader 在 load 和 forceload 下使用 <namespace>/<resource path> 形式保存资源：

config/txloader/load/
`-- <modid>/
    `-- guidenh/
        |-- assets/
        |   `-- example_structure.snbt
        `-- _zh_cn/
            `-- index.md

例如，标准资源包路径 assets/guidenh/guidenh/_zh_cn/index.md 在 TXLoader 中应写成 config/txloader/load/guidenh/guidenh/_zh_cn/index.md。config/txloader/forceload/ 下也使用同样的原生布局。

指南发现机制

GuideNH 现在会直接从资源树中发现页面。凡是位于 assets/<modid>/guidenh/_<lang>/... 下的 Markdown 文件，都会被视为 <modid>:guidenh 这本指南的一部分。 index.md 仍然是约定俗成的起始页，也是推荐的开始位置。

每个 <modid> 都拥有彼此隔离的指南命名空间。例如 assets/guidenh/guidenh/_zh_cn/index.md 和 assets/gregtech/guidenh/_zh_cn/index.md 是两份不同指南里的两个不同页面，分别属于 guidenh:guidenh 和 gregtech:guidenh。[Next](guide.md) 这样的相对链接会留在当前页面自己的 命名空间；需要跳到其他模组指南时，请显式写成 [GT 页面](gregtech:guide.md)。也支持 gregtech:/guide.md 这样的显式根路径。

本地快速迭代

如果你正在编辑本仓库的内置示例指南，推荐使用 实时预览 中说明的工作流。

该工作流会把 GuideNH 指向：

wiki/resourcepack/assets/guidenh/guidenh/

并在启动时自动打开这本指南。

第一个页面

---
navigation:
  title: Root
---

# Start Page

Welcome to GuideNH.

[Next Page](subpage.md)

添加导航元数据

用于导航的最小 frontmatter 形式是：

navigation:
  title: Root

如果没有 navigation frontmatter，页面仍然可以存在，也可以被直接链接到，但不会自动出现在指南导航树中。

如果还想让页面出现在首页推荐面板中，可以额外添加 navigation.recommend。 这个字段是可选的，0 是有效值，数值越大越靠前。

添加资源

把页面私有资源放在页面文件旁边：

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

然后在 Markdown 中使用相对路径引用：

![Example](test1.png)

把共享指南资源放到该指南自己的 assets/ 目录下：

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

然后使用指南根路径引用：

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

下一步

• 实时预览
• 指南页面格式
• 导航
• 图片与资源
• 标签参考