---
group:
  title: 如何使用
  order: 2
order: 1
title: 快速上手
---

## 什么是 dumi-theme-antd

<div align="left">

[![NPM version](https://img.shields.io/npm/v/dumi-theme-antd.svg?style=flat)](https://npmjs.org/package/dumi-theme-antd) [![NPM downloads](http://img.shields.io/npm/dm/dumi-theme-antd.svg?style=flat)](https://npmjs.org/package/dumi-theme-antd) [![Github Actions](https://github.com/KuangPF/dumi-theme-antd/workflows/Deploy/badge.svg)](https://github.com/KuangPF/dumi-theme-antd/actions)

</div>

`dumi-theme-antd` 是一款 [dumi][dumi-url] 主题包，主题风格参考 Antd Design 5.0 官网。基于 `dumi` 主题开发功能，深度定制开发了：

- 首页
- 导航栏
- 侧边栏
- 内容区
- 底部
- ...

## 安装

使用 pnpm 或 yarn 安装

<InstallDependencies npm='$ npm install dumi-theme-antd ' yarn='$ yarn add dumi-theme-antd' pnpm='$ pnpm install dumi-theme-antd '></InstallDependencies>

## 配置

`dumi-theme-antd` 基于`dumi`主题包约定开发，安装以后 `dumi` 会自动从 `packge.json` 中加载主题包，无需做其他任何配置。`dumi-theme-antd` 为了更好的适配 Antd Design 5.0 官网主题风格，也支持一些特定的配置参数，详情前往[配置](/config/base)。

[dumi-url]: https://d.umijs.org/