文档基于2025-10-10日社区最终版构建     
切换到英文版    进入演示系统    进入交流社区

MinIO Documentation

设计页面

概述

本页面旨在协助MinIO用户界面/用户体验的文档设计工作。可将其视为各类对象与标题的"样式总览",便于直观查看当前所有元素的呈现效果。此页面所展示的内容均实际存在于文档的其他部分。

如果您不从事 MinIO 用户界面/用户体验相关工作,本页面无有效内容。 请返回Index.

通用标记语言

文本标记

这是*斜体*文本

这是**粗体文本**

This is monospaced text

这是超链接文本

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

以下组件来自sphinx-design

Tabs

MinIO 采用 ExecutableBookssphinx-design标签页库。

这是纯文本内容。

这是包含代码的纯文本内容:

mc admin info ALIAS

您可以保持标签页同步。例如,当页面中存在多个同时包含控制台和CLI标签页的操作流程时。同步:键1关于教学的选择tab-item当用户选择某个标签页时,页面中所有具有相同标识键的其他标签页也会同步切换至该标签页。

这是纯文本内容。

这是包含代码的纯文本内容:

mc admin info ALIAS

卡片

这是卡片的标题

卡片标题

这是卡片内的内容。

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

echo "This is some code block"
此卡片可点击

点击此卡片将跳转至https://min.io

此卡片可点击

点击此卡片将带您前往该位置objects参考 锚点。

网格

网格中的第一项

网格中的第二项

网格中的第三项

子网格项 1

子网格项 2

子网格项 3

Card 1

卡片1内容

Card 2

卡片 2 内容

SubCard 1

子卡1内容

SubCard 2

子卡 2 内容

SubCard 3

子卡 3 内容

Header 1

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

Header 2

这是二级标题下的内容。该标题包含用于链接的锚点标签。本页目录配置为显示至二级标题。标题名称应显示在右侧目录中。

Header 3

这是三级标题下的内容。该标题包含用于链接的锚点标签。本页目录配置为显示至二级标题。标题名称应在右侧目录中显示。

Header 4

这是四级标题下的内容。该标题包含用于链接的锚点标签。本页目录配置为显示至多两级标题。标题名称应在右侧目录中显示。

包含的头文件

这是上方标题内的内容。 标题装饰必须与“父”文档相匹配

另一个标题

这是上方标题内的内容。 这应与前一个标题处于同一层级。

子标题

这是上一级标题下的内容小节。 它应该比上一级标题低一个层级。

警告框

MinIO 文档使用以下提示类型。 提示框的 HTML 代码结构如下:

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

在定义警告框时设置的附加类可以是任意字符串。Sphinx 提供了默认的warning, notecustom.

注意提示

该注释提示呈现如下:

Note

此文本位于注释正文中。它包含一些monospaced, bold斜体.

This is alink跳转到文档中的另一个页面。

This is alink指向外部页面。

您可以为笔记标题设置自定义文本:

自定义标题monospaced文本

此文本位于注释正文中。它包含一些monospaced, bold斜体.

This is alink跳转到文档中的另一个页面。

This is alink指向外部页面。

记录版本变更:

在版本 RELEASE.2022-07-15T09-20-55Z 中的变更:mc license register替换mc support register命令。

重要提示

重要提示的渲染效果如下:

重要

此文本位于正文重要部分。它包含一些monospaced, bold斜体.

This is alink跳转到文档中的另一个页面。

This is alink指向外部页面。

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

这是重要的标题,包含monospaced文本

此文本位于正文重要部分。它包含一些monospaced, bold斜体.

This is alink跳转到文档中的另一个页面。

This is alink指向外部页面。

警告提示

警告提示框的渲染效果如下:

警告

此文本位于警告正文中。它包含一些monospaced, bold斜体.

This is alink跳转到文档中的另一个页面。

This is alink指向外部页面。

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

这是警告标题,带有monospaced文本

此文本位于警告正文中。它包含一些monospaced, bold斜体.

This is alink跳转到文档中的另一个页面。

This is alink指向外部页面。

通用提示框

通用提示框可以应用任意类。如果我们希望使用非常特定的设计来显示提示框,这可能很有用。

注意标题

此文本位于警示框正文中。它包含一些monospaced, bold斜体.

This is alink跳转到文档中的另一个页面。

This is alink指向外部页面。

列表

列表表格

Sphinx 拥有特殊的标记语法,可用于生成整洁的表格,这与 ASCII 风格的表格定义形成对比。

以下内容.. list-table有一个单独的表头行和多个列:

行标题 1

行标题 2

行标题 3

行标题 4

列项目 1

列项 2

列项目 3

列项目 4

列项目 1

列项 2

列项目 3

列项目 4

列项目 1

列项 2

列项目 3

列项目 4

以下内容.. list-table使用存根列,其中第一列包含"标题"或名称:

行标题 1

列项目 1

列项 2

列项目 3

行标题 2

列项目 1

列项 2

列项目 3

行标题 3

列项目 1

列项 2

列项目 3

行标题 4

列项目 1

列项 2

列项目 3

项目符号和编号列表

这是一个项目符号列表:

  • Item A

  • Item B
    • 项目 B.1

    • 项目 B.2

  • Item C
    • 项目 C.1

    • 项目 C.2

    • 项目 C.3
      • 项目 C.3.1

      • 项目 C.3.2

这是一个编号列表:

  1. Item A

  2. Item B

  1. 项目 B.1

  2. 项目 B.2

  1. Item C

  1. 项目 C.1

  2. 项目 C.2

  3. 项目 C.3

  1. 项目 C.3.1

  2. 项目 C.3.2

定义列表

Sphinx标记语言包含用于生成描述列表及各类描述详情的语法。这些通常用于:锚定,因此其 实用性较为有限。它们可以作为一种创建视觉区分列表的好方法,便于快速滚动和查看。在参考文档中经常使用它们。

描述列表标题 1

这是该标题的描述正文。

此定义列表中的另一个段落

描述列表标题 2

这是该标题的描述正文。

此定义列表中的另一个段落

描述列表标题 3

这是该标题的描述正文。

此定义列表中的另一个段落

参考定义

Sphinx支持创建自定义的引用型指令。我们在文档中使用了多个此类指令。以下章节包含一些示例定义,初始表格链接至各个定义。

这里实际上有一个用于链接的顶层定义,但没有用于显示的顶层定义。这是有意为之(目前如此)。

foo 酒吧

用于定义CLI命令。

bin

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

baz

用于定义CLI命令的选项

foo

我们可以引用的通用数据位。

foo.酒吧

这些是嵌套且相互链接的。

--foo

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

Example:

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

图像

MinIO Console Landing Page provides a view of the Object Browser for the authenticated user