跳转到主要内容

这是本节的多页打印视图。 .

返回本页常规视图.

教程

通过完成一次小而完整的修改来学习项目。

跟随一个端到端任务,而不是只阅读彼此孤立的知识点。

1 - 完成第一次修改

完成一次小修改并在本地验证。

这篇示例教程展示一项完整任务:准备、修改、验证与复查。

从已知状态开始

git status --short
git switch -c docs/first-change

只修改一件事

修改一个可见字符串或一个小配置值。第一次任务应足够聚焦,让结果一目了然。

验证

运行项目最小而相关的检查,然后打开修改过的界面亲自确认。

2 - 添加文档页面

创建页面,把它放入侧栏,并建立链接。

在 OINK 中,内容树就是文档侧栏。新增一个 Markdown 文件,就会新增一个页面。

创建文件

---
title: 新能力
description: 这项能力做什么。
weight: 30
---

在这里说明这项能力。

将它保存为 content/docs/reference/new-capability.md

添加翻译

在旁边创建 new-capability.zh.mdnew-capability.fr.md。各语言的显式标题 ID 应当保持一致。

预览

运行 hugo server,打开新页面,再通过语言切换器检查每个译文。