索引页

卡片列表

您可以使用 DocCardList 组件将生成的卡片列表嵌入到普通文档页面中。它将显示当前文档的父类别的所有侧边栏项目。

mddocs/sidebar/index.md

import DocCardList from '@theme/DocCardList';

<DocCardList />

渲染：

📄️ intro

Docusaurus 是一个静态网站生成器，可以基于你的 Markdown 文档生成静态网站。生成网页的样式美观大方，适合文档类网站。

📄️ Docusaurus 安装

构建环境

📄️ 发布网站

构建网站

📄️ 主配置文件

Docusaurus 的主配置文件是 docusaurus.config.js ，它是一个标准的 JavaScript（或 TypeScript）导出对象，整个项目的运行和行为基本都由它控制。

📄️ MDX和React

MD 和 MDX 解析器

📄️ front-matter

front matter

📄️ 侧边栏

侧边栏的作用：将多个相关文档组织成有序树结构，在这些文档页面中统一显示侧边栏导航，支持在文档间显示“上一页 / 下一页”按钮。

📄️ 索引页

卡片列表

📄️ 博客

配置 docusaurus.config.js

目录配置文件

在相应的文件夹中添加 _category_.json 或 _category_.yml 文件。您可以指定任何类别元数据以及位置元数据。label、className、position 和 customProps 将默认为类别链接文档的相应值（如果有）。

JSON

jsondocs/tutorials/_category_.json

{
  "position": 2.5,
  "label": "Tutorial",
  "collapsible": true,
  "collapsed": false,
  "className": "red",
  "link": {
    "type": "generated-index",
    "title": "Tutorial overview"
  },
  "customProps": {
    "description": "This description can be used in the swizzled DocCard"
  }
}

yml

ymldocs/tutorials/_category_.yml

position: 2.5 # float position is supported
label: 'Tutorial'
collapsible: true # make the category collapsible
collapsed: false # keep the category open by default
className: red
link:
  type: generated-index
  title: Tutorial overview
customProps:
  description: This description can be used in the swizzled DocCard

数字前缀

为了更易于采用，Docusaurus 支持多种数字前缀模式。 01-*.md 、 01_*.md 、 01.*.md ，默认情况下，Docusaurus 将从文档 ID、标题、标签和 URL 路径中删除数字前缀。