这是一个占位页面，将其替换为您自己的内容。
此部分是您的项目的用户文档所在的位置 - 您的用户理解并成功使用您的项目所需的所有信息。
对于大型文档集，我们建议在本节的标题下添加内容，但如果其中部分或全部内容不适用于您的项目，请随意删除它们或添加您自己的内容。 您可以在 Docsy User Guide中查看较小的 文档站点的示例，如果您想复制其文档部分，该站点位于 Docsy theme repo 仓库中。
其他内容（例如营销材料、案例研究和社区更新）应位于关于和社区页面中。
在 Docsy User Guide中了解如何使用 Docsy 主题。 您可以在Organizing Your Content中了解有关如何组织内容（以及我们如何组织此网站）的更多信息。
这是一个占位页面，将其替换为您自己的内容。
概述是您的用户了解您的项目的地方。根据文档集的大小，您可以拥有单独的概述页面（如本页面）或将概述内容放在文档登录页面中（如 Docsy 用户指南中）。
尝试在此页面中为您的用户回答以下问题：
介绍您的项目，包括它做什么或让您做什么、为什么要使用它以及它的主要目标（以及它如何实现它）。 这应该与您的自述文件描述类似，但如果您愿意，您可以适当写一些小细节。
帮助您的用户知道您的项目是否会对他们有所帮助，有用的信息可以包括：
它有什么好处？：您的项目解决什么类型的问题？ 使用它有什么好处？
它有什么不好？：例如，指出直观上看起来适合您的项目但由于某种原因不适合的情况。 还要提及已知的限制、扩展问题或任何其他可能让用户知道该项目是否不适合他们的内容。
它尚未有什么用处？：突出显示即将推出的任何有用功能。
为您的用户提供进一步了解产品的指引。 例如：
这是一个占位页面，将其替换为您自己的内容。
本节中的信息可帮助您的用户亲自尝试您的项目。
您的用户需要做什么才能开始使用您的项目？这可能包括下载/安装说明，包括任何先决条件或系统要求。
介绍性“Hello World”示例（如果适用），更复杂的教程应该位于教程部分。
考虑在您的入门页面中使用以下标题，您可以删除任何不适用于您的项目的内容。
使用您的项目有任何系统要求吗？ 支持哪些语言（如果有）？ 用户是否需要已经安装任何软件或工具？
您的用户在哪里可以找到您的项目代码？ 他们如何安装它（二进制文件、可安装包、从源代码构建）？ 他们是否可以安装多个选项/版本？他们应该如何选择适合自己的选项/版本？
安装后用户需要进行任何初始设置才能尝试您的项目吗？
您的用户能否测试他们的安装，例如通过运行命令或部署 Hello World 示例？
这是一个占位页面，将其替换为您自己的内容。
文本可以是 粗体, 斜体, or 删除线，链接 显示为蓝色，且没有下划线（除非悬停在上面）。
段落之间应该有空格。蒸羊羔儿、蒸熊掌、蒸鹿尾儿、烧花鸭、烧雏鸡、烧子鹅、炉猪、炉鸭、酱鸡、腊肉、松花、小肚儿、晾肉、香肠儿、什锦苏盘儿、熏鸡白肚儿、清蒸八宝猪、江米酿鸭子、罐儿野鸡、罐儿鹌鹑、卤什件儿、卤子鹅、山鸡、兔脯、菜蟒、银鱼、清蒸哈什蚂、烩鸭腰儿、烤鸭条、清拌腰丝儿、黄心管儿、焖白鳝、焖黄鳝、豆鼓鲇鱼、锅烧鲤鱼、烀烂甲鱼、抓炒鲤鱼、抓炒对虾、软炸里脊、软炸鸡、什锦套肠儿、卤煮寒鸦儿、麻酥油卷儿、熘鲜蘑、熘鱼脯、熘鱼肚、熘鱼片儿、醋烟肉片儿、烟三鲜儿、烟鸽子蛋、熘白蘑、熘什件儿、炒银丝儿、烟刀鱼、清蒸火腿、炒白虾、炝青蛤、炒面鱼、炝竹笋、芙蓉燕菜、炒虾仁儿、熘腰花儿、烩海参、炒蹄筋儿、锅烧海参、锅烧白菜、炸木耳、炒肝尖儿、桂花翅子、清蒸翅子、炸飞禽。炸汁儿、炸排骨、清蒸江瑶柱、糖熘芡仁米、拌鸡丝、拌肚丝、什锦豆腐、什锦丁儿······。
糟鸭、糟熘鱼片、熘蟹肉、炒蟹肉、烩蟹肉、清拌蟹肉、蒸南瓜、酿倭瓜、炒丝瓜、酿冬瓜.烟鸭掌儿、焖鸭掌儿、焖笋、炝茭白、茄子晒炉肉、鸭羹、蟹肉羹、鸡血汤、三鲜木樨汤、红丸子、白丸子、南煎丸子、四喜丸子、三鲜丸子、氽丸子、鲜虾丸子、鱼脯丸子、饹炸丸子、豆腐丸子、樱桃肉、马牙肉、米粉肉、一品肉、栗子肉、坛子肉、红焖肉、黄焖肉、酱豆腐肉、晒炉肉、炖肉、黏糊肉、烀肉、扣肉、松肉、罐儿肉、烧肉、大肉、烤肉、白肉······。
第一句上方不应有空白。
块引用显示为浅灰色，左侧有辅助颜色的边框。
最后一句下面不应有空白。
这是标题后面的正常段落。红肘子、白肘子、熏肘子、水晶肘子、蜜蜡肘子、锅烧肘子、扒肘条、炖羊肉、酱羊肉、烧羊肉、烤羊肉、清羔羊肉、五香羊肉、氽三样儿、爆三样儿、炸卷果儿、烩散丹、烩酸燕儿、烩银丝儿、烩白杂碎、氽节子、烩节子、炸绣球、三鲜鱼翅、栗子鸡、氽鲤鱼、酱汁鲫鱼、活钻鲤鱼、板鸭、筒子鸡、、烩脐肚、烩南荠、爆肚仁儿、盐水肘花儿、锅烧猪蹄儿、拌稂子、炖吊子、烧肝尖儿、烧肥肠儿、烧心、烧肺、烧紫盖儿、烧连帖、烧宝盖儿、油炸肺、酱瓜丝儿、山鸡丁儿、拌海蜇、龙须菜、炝冬笋、玉兰片、烧鸳鸯、烧鱼头、烧槟子、烧百合、炸豆腐、炸面筋、炸软巾······。
吃葡萄不吐葡萄皮儿，不吃葡萄倒吐葡萄皮儿。
在大屏幕上，段落和标题不应占据整个容器宽度，但我们希望表格、代码块和类似内容占据整个容器宽度。
这是标题后的一个块引用。扁担长，板凳宽，板凳没有扁担长，扁担没有板凳宽。扁担要绑在板凳上，板凳不让扁担绑在板凳上，扁担偏要扁担绑在板凳上。
这是代码块。
四是四，十是十，十四是十四，四十是四十，谁要把十四说成四十就打谁十四，谁要把四十说成十四就打谁四十，十四四十四十四，私自试一试。
| What | Follows |
|---|---|
| A table | A header |
| A table | A header |
| A table | A header |
这一行的上方和下方有一条水平线。
这是一个无序列表：
这是一个有序列表：
这是一个无序任务列表：
这是一个“混合的”任务列表：
这是一个嵌套列表：
定义列表可以与 Markdown 语法一起使用，定义术语为粗体。
表格的标题显示为粗体，行背景有交替的阴影。
| Artist | Album | Year |
|---|---|---|
| Michael Jackson | Thriller | 1982 |
| Prince | Purple Rain | 1984 |
| Beastie Boys | License to Ill | 1986 |
如果表格太宽，它应该水平滚动。
| Artist | Album | Year | Label | Awards | Songs |
|---|---|---|---|---|---|
| Michael Jackson | Thriller | 1982 | Epic Records | Grammy Award for Album of the Year, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Selling Album, Grammy Award for Best Engineered Album, Non-Classical | Wanna Be Startin’ Somethin’, Baby Be Mine, The Girl Is Mine, Thriller, Beat It, Billie Jean, Human Nature, P.Y.T. (Pretty Young Thing), The Lady in My Life |
| Prince | Purple Rain | 1984 | Warner Brothers Records | Grammy Award for Best Score Soundtrack for Visual Media, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Soundtrack/Cast Recording, Grammy Award for Best Rock Performance by a Duo or Group with Vocal | Let’s Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I’m a Star, Purple Rain |
| Beastie Boys | License to Ill | 1986 | Mercury Records | noawardsbutthistablecelliswide | Rhymin & Stealin, The New Style, She’s Crafty, Posse in Effect, Slow Ride, Girls, (You Gotta) Fight for Your Right, No Sleep Till Brooklyn, Paul Revere, Hold It Now, Hit It, Brass Monkey, Slow and Low, Time to Get Ill |
代码片段 var foo = "bar"; 可以内联显示。
也可以像这样, this should vertically align with thisand this.
代码也可以显示在块元素中。
foo := "bar";
bar := "foo";
代码还可以使用语法高亮显示。
func main() {
input := `var foo = "bar";`
lexer := lexers.Get("javascript")
iterator, _ := lexer.Tokenise(nil, input)
style := styles.Get("github")
formatter := html.New(html.WithLineNumbers())
var buff bytes.Buffer
formatter.Format(&buff, style, iterator)
fmt.Println(buff.String())
}
长的单行代码块不应换行，如果它们太长，它们应该水平滚动，这一行应该足够长来证明这一点。从前有座山，山上有座庙，庙里有个老和尚，老和尚在给小和尚讲故事，故事讲的是从前有座山，山上有座庙，庙里有个老和尚，老和尚在给小和尚讲故事······
表格单元格内的内联代码仍然能突出显示。
| Language | Code |
|---|---|
| Javascript | var foo = "bar"; |
| Ruby | foo = "bar"{ |
小图片应以其实际尺寸显示。
大图片应缩小并适配内容容器。
The photo above of the Spruce Picea abies shoot with foliage buds: Bjørn Erik Pedersen, CC-BY-SA.
在此处添加一些部分以查看目录的外观。Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
Inguina genus: Anaphen post: lingua violente voce suae meus aetate diversi. Orbis unam nec flammaeque status deam Silenum erat et a ferrea. Excitus rigidum ait: vestro et Herculis convicia: nitidae deseruit coniuge Proteaque adiciam eripitur? Sitim noceat signa probat quidem. Sua longis fugatis quidem genae.
Tilde photo booth wayfarers cliche lomo intelligentsia man braid kombucha vaporware farm-to-table mixtape portland. PBR&B pickled cornhole ugh try-hard ethical subway tile. Fixie paleo intelligentsia pabst. Ennui waistcoat vinyl gochujang. Poutine salvia authentic affogato, chambray lumbersexual shabby chic.
Plaid hell of cred microdosing, succulents tilde pour-over. Offal shabby chic 3 wolf moon blue bottle raw denim normcore poutine pork belly.
Stumptown PBR&B keytar plaid street art, forage XOXO pitchfork selvage affogato green juice listicle pickled everyday carry hashtag. Organic sustainable letterpress sartorial scenester intelligentsia swag bushwick. Put a bird on it stumptown neutra locavore. IPhone typewriter messenger bag narwhal. Ennui cold-pressed seitan flannel keytar, single-origin coffee adaptogen occupy yuccie williamsburg chillwave shoreditch forage waistcoat.
这是页面上的最后一个元素，下面不应有边距。
这是一个占位符页面，将其替换为您自己的内容。
如果为您的用户准备了示例应用程序或代码，请把它们链接到这里。
这是一个占位页面，将其替换为您自己的内容。
对于许多项目来说，概览中的信息对于用户来说可能已经足够，因此此部分是可选的。但是，如果您的用户在某些领域需要更详细地了解给定术语或功能，以便对您的项目做任何有用的事情（或者在使用项目时不犯错误），请将该信息放在本节中。例如，如果您有一个包含许多组件和复杂架构的大型项目，您可能需要添加一些概念页面。
记住要关注用户需要了解的内容，而不仅仅是您认为项目有趣的内容！如果他们不需要了解您的原始设计决策来使用或为项目做出贡献，请不要将它们放入，或将您的设计文档包含在您的代码仓库中并链接到它们。同样，大多数用户可能需要更多地了解功能在使用时如何工作，而不是它们是如何实现的。考虑使用单独的架构页面展示更详细的实现和系统设计信息，以帮助获取潜在项目贡献者。
这是一个占位页面，将其替换为您自己的内容。
考虑您的项目的功能和用例，使用这些来选择您的核心任务，每个用例（启用 x、配置 y）应具有相应的任务页面或任务页面段落。当用户需要了解如何做一件特定的事情时，他们应该能够快速参考您的核心任务，而不必在更大的教程或示例中寻找说明。将您的任务页面视为一本专题手册，其中包含不同的过程，您的用户可以组合起来创建更充实的内容。
您可以为每个任务提供一个页面，也可以将相关任务分组在一个页面中，例如与特定功能相关的任务。除了将相关任务分组到单个页面中之外，您还可以将任务页面分组到嵌套文件夹中，并以索引页作为概述，如本示例网站所示。或者，如果您有一个小型文档集，例如没有教程或概念页面的 Docsy User Guide，请考虑在文档的顶层而不是任务部分添加特定于功能的页面。
每个任务应该告知用户
这是一个占位页面，将其替换为您自己的内容。
这是一个占位页面，将其替换为您自己的内容。
这是一个索引页
这是一个占位页面，将其替换为您自己的内容。
教程是完整的工作示例，由多个任务组成，指导用户完成一个相对简单但现实的场景：例如，构建一个使用项目的某些功能的应用程序。如果您已经为您的项目创建了一些示例，您可以根据它们创建教程。此部分是可选。但是，请记住，虽然您一开始可能不需要本节，但教程对于帮助您的用户使用示例代码很有用，特别是当某些方面需要更多解释而您无法在代码注释中轻松提供时。
这是一个占位页面，将其替换为您自己的内容。
如果您的项目有 API、配置或其他参考 — 用户需要查找的任何内容，其粒度甚至比单个任务更低），请将其放在此处（或链接到它）。您可以提供并链接到使用 Doxygen 创建的生成的参考文档，
Javadoc 或其他文档生成工具，将它们放入static/目录中。如需了解更多信息，请参阅添加静态内容。对于 OpenAPI，Docsy 还提供了一个 Swagger UI 布局和简码 来呈现 Swagger UI 使用任何 OpenAPI YAML 或 JSON 文件作为源。
这些基本示例假设您的 Docsy 站点是使用 Netlify 部署的，并且您的文件存储在 GitHub 中。您可以“按原样”使用这些指南，也可以根据自己的需要进行调整：例如，其他部署选项、有关文档项目文件结构的信息、特定于项目的审核指南、版本控制指南或您的用户可能认为有用的任何其他信息。 Kubeflow 有一个很好的例子。
不要忘记链接到您自己的文档仓库而不是我们的示例网站！还要确保用户可以从您的文档仓库的自述文件中找到这些指南：将它们链接到本页面，或者链接到README，或者将它们包含在这两个位置。
我们使用 Hugo 来格式化和生成我们的网站， 用 Docsy 主题来构建样式和组织网站结构， 用 Netlify 来管理站点的部署。 Hugo是一个开源静态站点生成器，为我们提供模板， 组织内容的标准目录结构，以及网站生成引擎。你用 Markdown（或者 HTML，如果你愿意的话）编写页面，Hugo 将它们组装到一个网站中。
所有提交的内容，包括项目成员提交的内容，都需要审核。我们通过 GitHub 的 pull requests 机制来实现这一目标。查看 GitHub 帮助 了解更多有关 pull requests 的信息。
这是更新文档的快速指南。它假设您熟悉 GitHub 工作流程，并且您很乐意使用文档的自动预览更新：
如果您在使用文档时刚刚发现想要更改的内容，Docsy 为您提供了一个快捷方式：
如果您想在的本地运行 Hugo 服务器以预览更改：
按照入门中的说明安装 Hugo 和您需要的任何其他工具。您至少需要 Hugo 0.45 版本（我们建议使用最新的可用版本），并且必须是支持 SCSS 的扩展版本。
将 Goldydocs 仓库 仓库 Fork 到您自己的项目中，然后使用 git clone 创建本地副本。不要忘记使用--recurse-submodules，否则您将无法提取生成工作站点所需的一些代码。
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
在站点根目录下运行 hugo server。默认情况下，您的站点将位于 http://localhost:1313/。现在您已在本地提供网站服务，Hugo 将监视内容更改并自动刷新您的网站。
继续常规的 GitHub 工作流程来编辑文件、提交文件、推送更改您的 Fork，并创建拉取请求。
如果您在文档中发现问题，但不确定如何自行修复，请在 Goldydocs 仓库 中创建 issue。您还可以通过单击页面右上角的 提交文档问题 按钮来创建有关特定页面的问题。