md使用说明

提示框示例

这里写提示内容,支持 HTML 标签,如 代码

提示卡片示例

Warning

注意:此功能仅适用于新版 Docker。

Tip

这是一个普通提示。

Danger

危险操作!

INFO

这是一个 info 类型的 block

DETAILS

这是一个 details 类型的 block

自定义标题

自定义标题的 block

步骤指示器示例

  1. 第一步:下载安装包
  2. 第二步:配置环境变量
  3. 第三步:启动服务

代码块展示

参数说明:

  • ini:语言
  • wrapCode:自动换行
  • fold height::折叠高度
  • title:文件名

显示效果如下

ssh.ini
ys=ssl
ss=12312
ff=sdfs333333333333333333333333333c34jcj3rc34jkrc3jck34kc3crj4kckjrjkc3jkr3kcr3krk3rkc4rj3cjk4ckr3jc4rjk43jcr3jkcrk3jc4kr3jk4cjkr3c4jk

console.log("Hello Rspress");

这是一个引用块示例。

名称类型
Rspress文档框架
React前端框架

Overview 页 - Rspress

Overview 页用于展示某个目录下所有文章的概览,会自动从侧边栏提取信息并生成分组内容。

用法

在目录的 index.md​ 中配置 overview: true 即可开启:

---
overview: true
title: API Overview
---

这是 API 的概览页面。

Overview 页会自动读取当前目录的侧边栏配置,提取各文章的标题生成分组卡片。

示例

假设有如下目录结构:

生成的 Overview 页面如下:

嵌套 Overview 页

子目录同样可以有自己的 Overview 页,只需在子目录的 index.md​ 中配置 overview: true