跳到主要内容

添加文档

现在我们完成了代码，是时候为您的路由添加文档了。在 文档 (/website/docs) 中打开相应的文件，本例中是 website/docs/routes/programming.mdx。

为了实时预览文档，您需要在 website 目录 下安装文档的依赖项。在终端中输入以下命令：

pnpm i

您现在可以在 website 目录 下运行以下命令实时预览中文文档：

pnpm run start:zh
英文文档

运行以下命令实时预览英文文档

pnpm run start
注意

在开发模式下，您无法切换到其他语言。这是 Docusaurus 的 技术限制。

文档使用 MDX v3 编写，并使用 Docusaurus v3 渲染。

要为您的路由添加文档，请使用 Route React 组件。它类似于 HTML 标签。以下是最常用的组件属性：

  • author：路由维护者，用单个空格分隔。应与 maintainer.js 相同
  • example：路由示例，以 / 开头
  • path：路由，应与添加命名空间后 maintainer.js 中的键相同。在之前的教程中，它为 /github/issue/:user/:repo?
  • paramsDesc：路由参数描述，以字符串数组形式，支持 Markdown。
  • 描述必须按照它们在路由中出现的顺序。
  • 描述的数量应与 path 中的参数数量匹配。如果漏掉一个描述，则构建过程会失败。
  • 以 ?，* 或 + 结尾的路由参数将自动分别标记为可选，零个或多个或一个或多个，无须再次提及。
  • 没有符号后缀的路由参数将自动标记为必选
  • 如果参数是可选的，请提及其默认值。

文档示例​

仓库 Issues（无参数）​

<Route author="HenryQW" example="/sspai/series" path="/sspai/series" />

👨‍💻 作者：@HenryQW

💡 举例：https://rsshub.mlj-dragon.cn/sspai/series

🚏 路由：/sspai/series

参数：无

仓库 Issues（多个参数）​

<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub 用户名', 'GitHub 仓库名称，默认为 `RSSHub`']} />

👨‍💻 作者：@HenryQW

💡 举例：https://rsshub.mlj-dragon.cn/github/issue/DIYgod/RSSHub

🚏 路由：/github/issue/:user/:repo?

⚙️ 参数：

  • user，必选 — GitHub 用户名
  • repo，可选 — GitHub 仓库名称，默认为 RSSHub

关键词（带表格的说明）​

<Route author="DIYgod" example="/pixiv/search/Nezuko/popular/2" path="/pixiv/search/:keyword/:order?/:mode?" paramsDesc={['关键词', '排序方式，`popular` 按热门度排序，空或其他任意值按时间排，默认为 `date`', '过滤方式，见下表 默认为空']}>

| 只看非 R18 内容 | 只看 R18 内容 | 不过滤   |
| ------------ | -------- | ------------ |
| safe         | r18      | 空或其他任意值 |

</Route>

👨‍💻 作者：@DIYgod

💡 举例：https://rsshub.mlj-dragon.cn/pixiv/search/Nezuko/popular/2

🚏 路由：/pixiv/search/:keyword/:order?/:mode?

⚙️ 参数：

  • keyword，必选 — 关键词
  • order，可选 — 排序方式，popular 按热门度排序，空或其他任意值按时间排，默认为 date
  • mode，可选 — 过滤方式，见下表 默认为空
只看非 R18 内容只看 R18 内容不过滤
safer18空或其他任意值

自定义容器​

如果您想提供关于路由的更多信息，可以使用这些自定义容器：

<details>
  <summary>点击展开全文</summary>
  这是一个详细块，标题 (summary) 是可选的，不支持 Markdown。
</details>

:::note

这是一个备注。

:::

:::tip[提示标题]

标题是可选的。

:::

:::info

内容支持 Markdown。

:::

:::warning

开始和结束的 `:::` 周围需要空出一行

:::

:::danger

否则内容可能无法正常渲染。

:::
Details

点击展开全文 这是一个详细块，标题 (summary) 是可选的，不支持 Markdown。

备注

这是一个备注。

提示标题

标题是可选的。

信息

内容支持 Markdown。

注意

开始和结束的 ::: 周围需要空出一行

危险

否则内容可能无法正常渲染。

其他组件​

除了上述组件属性之外，还有几个组件属性可用于提供有关路径的更多信息：

  • anticrawler：如果目标网站有反爬机制，则设置为 1。
  • puppeteer：如果源使用 puppeteer 抓取，则设置为 1。
  • radar：如果此源有相应的 Radar 规则，则设置为 1。
  • configRequired：如果 RSS 源需要通过环境变量进行额外配置，则设置为 1。
  • supportBT：如果支持被 BitTorrent 客户端识别，则设置为 1。
  • supportPodcast：如果源支持播客，则设置为 1。
  • supportScihub：如果源支持 Sci-Hub，则设置为 1。

通过添加这些属性，您可以向用户提供有用的信息，并使其更易于理解和使用您的路由。将这些属性添加到路由文档中将在其前面添加一个徽章。

<Route author="HenryQW" example="/github/issue/DIYgod/RSSHub" path="/github/issue/:user/:repo?" paramsDesc={['GitHub 用户名', 'GitHub 仓库名称，默认为 `RSSHub`']} anticrawler="1" puppeteer="1" radar="1" configRequired="1" supportBT="1" supportPodcast="1" supportScihub="1" />

🚨 反爬严格🔄 支持 BT🎙️ 支持播客🧪 支持 Sci-Hub🎭 依赖 Puppeteer⚙️ 需要配置🔍 支持 Radar

👨‍💻 作者：@HenryQW

💡 举例：https://rsshub.mlj-dragon.cn/github/issue/DIYgod/RSSHub

🚏 路由：/github/issue/:user/:repo?

⚙️ 参数：

  • user，必选 — GitHub 用户名
  • repo，可选 — GitHub 仓库名称，默认为 RSSHub

其他事项​

  • 为路由添加文档时，请使用三级标题（###）。如果路由文档没有二级标题，则添加二级标题（##）。
  • 在每个标题和内容之间留一个空行。这有助于确保文档可以成功构建。
  • 如果文档包含大型表格，建议将其放入 details 容器 中。
  • 组件可以有两种写法：自闭合标签形式（<Route .../>）或成对标签形式（<Route>...</Route>）。
  • 别忘了关闭标签！
  • 在提交 Pull Request 之前，请务必运行在 RSSHub 的根目录运行以下命令检查和格式化您的代码：
pnpm run format
编辑此页
最后由 Dragon-MLJ 于 更新