跳到主要内容

提示窗口模板

以下模板为在您编写文档时可能会用到的提示模板,请按照要求使用以下的模板,以帮助我们统一样式!

新文章模板

在创建一篇新文章的时候,你可以从下面的模板复制粘贴,写一篇新文章出来。当然,我们对正文的要求都在群文档编辑指南,但是其中大多数都是指导性标准。

xxx.md
---
sidebar_position: <在侧边栏的排序>
description: <文章描述>
authors: [<作者1>,<作者2>,...]
---

# 标题

:::tip

该文章正在编写中。在该窗口被移除前,请不要对文章内容进行进一步的修改与提交。

:::

正文

其中,模板中的文档前言(Front Matter)中,如果有多个作者,请使用英文逗号分隔。

在编写完文章之后,你可以将开头的那个高亮块删除。

格式审查模板

该窗口应置于未经格式审查的文章开头,以作格式审查提示。

提示

该文章目前尚未经过格式规范审查。经审查后,该提示窗口将被移除。

复制下面的代码以应用到你的文档中。

:::tip

该文章目前尚未经过格式规范审查。经审查后,该提示窗口将被移除。

:::

内容编辑中模板

该窗口应置于还未编写完成的文章开头

提示

该文章正在编写中。在该窗口被移除前,请不要对文章内容进行进一步的修改与提交。

复制下面的代码以应用到你的文档中。

:::tip

该文章正在编写中。在该窗口被移除前,请不要对文章内容进行进一步的修改与提交。

:::

内容需改进模板

该窗口应置于内容需要改进的文章开头或结尾

提示

该文章的内容需要改进。

理由:「理由」

「需改进的内容具体位置」

复制下面的代码以应用到你的文档中。其中,「」符号内包裹的部分是你要更改的内容。

:::tip

该文章的内容需要改进。

理由:「理由」

「需改进的内容具体位置」

:::

内容扩充模板

该窗口应置于需要扩充内容的文章开头

提示

该文章的内容需要扩充。您可以帮助我们扩充更多信息。

复制下面的代码以应用到你的文档中。

:::tip

该文章的内容需要扩充。您可以帮助我们扩充更多信息。

:::

外来文档模板

该窗口应置于整篇添加到群文档的文章开头,常在归档页面中使用。

信息

此文章由 「某人」 编写。

(如果被修改过) 在被添加到群文档时,文章由 「某人」 对 「某部分」 略作修改,使其 「效果」。

(如果未被修改) 在被添加到群文档时,文章未被修改。

如有阅读原文的需求,请前往 「原文页面」。

复制下面的代码以应用到你的文档中。其中,「」符号内包裹的部分是你要更改的内容。

:::info

此文章由 「某人」 编写。

(如果被修改过) 在被添加到群文档时,文章由 「某人」 对 「某部分」 略作修改,使其 「效果」。

(如果未被修改) 在被添加到群文档时,文章未被修改。

如有阅读原文的需求,请前往 「原文页面」。

:::

归档模板

该窗口应置于整篇添加到群文档的文章开头,常在归档页面中使用。

信息

「归档原因」,故归档。

最后一次编辑由 「某人」 进行,位于 「yy/mm/dd(-HH:MM) or commit」。

复制下面的代码以应用到你的文档中。其中,「」符号内包裹的部分是你要更改的内容。

:::info

「归档原因」,故归档。

最后一次编辑由 「某人」 进行,位于 「`yy/mm/dd(-HH:MM)` or commit」。

:::

停更模板

该窗口应置于整篇添加到群文档的文章开头,常在归档页面中使用。

注意

该地图已经停更,不再接受任何非必要的漏洞反馈。

停更时间 「YYYY」 年 「mm」 月,停更版本 「version」(基于 「基岩版/Java 版」 「版本兼容下限」)。

复制下面的代码以应用到你的文档中。其中,「」符号内包裹的部分是你要更改的内容。

:::warning

该地图已经停更,不再接受任何非必要的漏洞反馈。

停更时间 「YYYY」 年 「mm」 月,停更版本 「version」(基于 「基岩版/Java 版」 「版本兼容下限」)。

:::

无需遵守标准格式模板

该窗口应放置于群资源更新日志类别的文章开头,以声明该文章可以不遵守与其他文章相同的标准格式。

提示

为保证和原始更新日志一致,日志文本无须遵守格式规范,且不作相关调整。

复制下面的代码以应用到你的文档中。

:::tip

为保证和原始更新日志一致,日志文本无须遵守格式规范,且不作相关调整。

:::