---
group:
  title: Basic Usage
  order: 2
order: 1
title: Getting Started
---

## What is 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` is a [dumi][dumi-url] theme package, the theme style refers to Antd Design 5.0 official website. Based on `dumi` theme development function, deeply customized and developed:

- HomePage
- Navigation
- Sidebar
- Content
- Footer
- ...

## Install

Install using pnpm or yarn

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

## Usage

`dumi-theme-antd` is developed based on the `dumi` theme package convention. After installation, `dumi` will automatically load the theme package from `packge.json` without any other configuration. `dumi-theme-antd` also supports some specific configuration parameters in order to better adapt to the Antd Design 5.0 official website theme style, go to [Configuration](/config/base-en) for details.

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