中文文档

设计页面

概述

此页面旨在帮助MinIO团队在文档方面进行用户界面(UI)和用户体验(UX)工作。 可以将它想象成一个 ‘厨房水槽’,包含了各种对象和头部的集合, 这样可以更方便地查看目前的样子。如果这个页面上有的内容, 那么在文档的其他地方也存在。

如果你不是在从事MinIO的UI/UX工作,那么这个页面对你来说没有有用的内容。 返回索引页面的 Index

通用标记

文本标记

这是斜体文本

这是粗体文字

这是等宽文本

这是超链接文本

echo "This is a code block. It includes as small copy hover in the top-right."

echo "Syntax highlighting is automatic via pygments."

集装箱

该文本位于容器中。 容器有助于自定义渲染 的文本。 将自定义类添加到容器中以测试 CSS:

.. container::
   :class: class-name

狮身人面像设计

以下组件来自 sphinx-design

选项卡

MinIO 使用 ExecutableBooks sphinx-design 选项卡库。

这是纯文本内容

这是带有代码的纯文本内容:

mc admin info ALIAS

您可以使标签保持同步。 例如,如果页面上有多个具有控制台和 CLI 选项卡的过程。 在每一个 tab-item 上使用 :sync: key1 选项。 当用户选择一个标签页时,具有相同键的其他所有标签页也会更改为该标签页。

这是纯文本内容

这是带有代码的纯文本内容:

mc admin info ALIAS

Cards

这是卡片的标题

Title of the card

这是卡内的内容。

该卡可以包含不同的内容。

echo "This is some code block"
This card is clickable

单击此卡将带您访问 https://minio.org.cn

This card is clickable

点击此卡片将带你到 objects 参考锚点的 位置。

Grids

网格中的第一个项目。

网格中的第二个项目。

网格中的第三个项目。

子网格项目 1

子网格项目 2

子网格项目 3

Card 1

卡1内容

Card 2

卡2内容

SubCard 1

子卡1内容

SubCard 2

子卡2内容

SubCard 3

子卡3内容

标头 1

这是第1级标题下的内容。 标题包含一个锚点标签用于链接。 此页面的目录配置为显示最多2级标题。 标题应在右侧目录中显示。

标头 2

这是二级标题下的内容。标题包含一个锚点标签用于链接。 此页面的目录配置为显示最多两级标题。 标题应在右侧目录中显示。

标头 3

这是三级标题下的内容。标题包含一个锚点标签用于链接。 由于此页面的目录配置为显示最多两级标题, 所以三级标题的标题不会在右侧目录中显示。

标头 4

这是四级标题下的内容。标题包含一个锚点标签用于链接。 由于此页面的目录配置为显示最多两级标题, 所以四级标题的标题 不会 在右侧目录中显示。

Admonitions

MinIO文档使用了以下几种注意事项类型。 注意事项的HTML代码类似于以下形式:

<div class="admonition [warning|important|note|custom]>
   <p class="admonition-title"></p>
</div>

额外的类在定义注意事项时设置,可以是任何任意的字符串。 Sphinx关于 warningnotecustom 有默认设置。

Note Admonition

注释警告呈现如下:

备注

这段文本是注意事项的主体。它包括一些 ``monospaced``(等宽字体)、 bold (加粗)和 italics (斜体)。

这是一个链接到文档中另一页面的链接:link

这是一个到外部页面的链接 link

您可以为注意事项标题设置自定义文本:

Custom title with monospaced text

这段文本是注意事项的主体。它包括一些 ``monospaced``(等宽字体)、 bold (加粗)和 italics (斜体)。

这是一个链接到文档中另一页面的链接:link

这是一个到外部页面的链接: link

为了记录一个版本变更:

在 RELEASE.2022-07-15T09-20-55Z 版本发生变更: mc license register 取代了原来的 mc support register 命令。

重要警告

重要警告如下:

重要

这段文本是在重要的正文部分。它包括一些 ``monospaced``(等宽字体)、 bold (粗体)和 italics (斜体)。

这是一个链接 link 到文档中的另一页。

这是一个链接 link 到一个外部页面。

您可以为重要的标题设置自定义文本:

This is the important title with monospaced text

这段文本是在重要的正文部分。它包括一些 ``monospaced``(等宽字体)、 bold (粗体)和 italics (斜体)。

这是一个链接 link 到文档中的另一页。

这是一个链接 link 到一个外部页面。

Warning Admonition

警告提示如下:

警告

这段文本是在警告正文中。它包括一些 ``monospaced``(等宽字体)、 **bold**(粗体)和 *italics*(斜体)。

这是一个链接 link 到文档中的另一页。

这是一个链接 link 到一个外部页面。

您可以为警告标题设置自定义文本:

This is the warning title with monospaced text

这段文本是在警告正文中。它包括一些 ``monospaced``(等宽字体)、 **bold**(粗体)和 *italics*(斜体)。

这是一个链接 link 到文档中的另一页。

这是一个链接 link 到一个外部页面。

一般警告

通用警告(admonition)可以应用任何任意类。 如果我们想要使用非常具体的设计来显示一个警告,这可能很有用。

admonition-title

这段文本是在警告(admonition)的主体中。它包括一些 ``monospaced``(等宽字体)、 **bold**(粗体)和 *italics*(斜体)。

这是一个链接 link 到文档中的另一页。

这是一个链接 link 到一个外部页面。

Lists

List Table

Sphinx 有特殊的标记语法用于生成整洁的表格,而不是 ASCII 风格的 表格定义。

下面的 .. list-table 包含一个标题行和多个列:

行标题 1

行标题 2

行标题 3

行标题 4

列项目 1

列项目 2

列项目 3

列项目 4

列项目 1

列项目 2

列项目 3

列项目 4

列项目 1

列项目 2

列项目 3

列项目 4

下面的 .. list-table 使用了一个短列(stub column), 其中第一列包含 “标头” 或标题 :

行标题 1

列项目 1

列项目 2

列项目 3

行标题 2

列项目 1

列项目 2

列项目 3

行标题 3

列项目 1

列项目 2

列项目 3

行标题 4

列项目 1

列项目 2

列项目 3

项目符号和编号列表

这是一个项目符号列表:

  • Item A

  • Item B
    • Item B.1

    • Item B.2

  • Item C
    • Item C.1

    • Item C.2

    • Item C.3
      • Item C.3.1

      • Item C.3.2

这是一个编号列表:

  1. Item A

  2. Item B

  1. Item B.1

  2. Item B.2

  1. Item C

  1. Item C.1

  2. Item C.2

  3. Item C.3

  1. Item C.3.1

  2. Item C.3.2

定义列表

Sphinx 的标记语法包括用于生成描述列表(Description List)和 各种描述细节(Description Details)的语法。 这些通常 不是 锚定的,因此它们的实用性有所限制。 它们可以作为一种创建视觉上 distinct 的列表的方式, 以便快速滚动和查看。在参考文档中经常使用它们。

描述列表标题 1

这是该标题的描述正文。

此定义列表中的另一段

描述列表标题 2

这是该标题的描述正文。

此定义列表中的另一段

描述列表标题 3

这是该标题的描述正文。

此定义列表中的另一段

参考定义

Sphinx 支持创建自定义的参考类型指令。 我们在文档中使用了几种。下面的章节包括一些示例定义。 最初的表格链接到每个定义。

实际上在这里有一个顶级定义,用于链接,但不用于 显示。这是故意的(至少目前是这样)。

foo bar

用于定义 CLI 命令。

bin

用于定义 CLI 命令的各种参数

baz

用于定义 CLI 命令的选项

foo

我们可以参考的通用数据。

foo.bar

它们是嵌套和链接的。

--foo

用于定义 CLI 命令的全局参数。

Example:

:std:option:`--json <mc.--json>`

Images

MinIO 控制台登录页面为认证用户提供了对象浏览器的视图。
Join Slack 商业支持购买咨询