小能豆

请问,Ant Design Pro 文档系统使用的是哪个开源框架实现的吗?

javascript

请问,Ant Design Pro 文档系统使用的是哪个开源框架实现的吗?


阅读 51

收藏
2024-06-02

共1个答案

小能豆

Ant Design Pro 的文档系统使用的是 dumi 框架来实现的。dumi 是一个为组件开发、文档和展示而设计的文档生成工具,是 Umi(一个基于 React 的企业级前端应用框架)的子项目。它专注于帮助开发者构建组件库及其文档,支持 Markdown 和 JSX 的混合编写方式,可以很方便地生成文档网站。

dumi 主要特性

  • Markdown 驱动:使用 Markdown 编写文档内容,支持常见的 Markdown 语法扩展。
  • React 组件:在 Markdown 中可以直接使用 React 组件,方便进行组件示例展示。
  • 内置主题:提供了多种默认主题,同时支持自定义主题。
  • 多语言支持:内置国际化支持,方便构建多语言文档站点。
  • 自动生成菜单和路由:根据文件结构自动生成导航菜单和路由配置。
  • 开发体验:内置开发服务器,支持热更新和快速预览。

如何使用 dumi

以下是一个简单的示例,展示如何使用 dumi 创建一个文档网站。

  1. 安装 dumi

sh npm install -g dumi

  1. 创建一个 dumi 项目

sh mkdir my-dumi-app cd my-dumi-app npm init -y npm install dumi

  1. 配置 dumi

在项目根目录创建 .dumirc.js 配置文件:

js // .dumirc.js export default { title: 'My Dumi App', mode: 'site', };

  1. 编写文档

docs 目录下创建一个 index.md 文件:

```md
# Hello dumi!

这是一个 dumi 生成的文档示例。

```jsx
import React from ‘react’;

export default () =>

Hello dumi!

;

  1. 运行开发服务器

sh npm run docs:dev

  1. 构建生产版本

sh npm run docs:build

以上步骤将创建并启动一个简单的 dumi 文档站点,您可以在浏览器中查看和编辑文档。

Ant Design Pro 文档系统

Ant Design Pro 使用 dumi 来管理和展示其文档,包括所有的指南、API 文档、示例代码等。通过 dumi,Ant Design Pro 文档系统实现了高效的文档编写和展示,提升了开发者的使用体验。

更多详细信息可以参考 dumi 的官方文档:https://d.umijs.org/

2024-06-02