# vuepress-theme-antdocs

**Repository Path**: zpfz/vuepress-theme-antdocs

## Basic Information

- **Project Name**: vuepress-theme-antdocs
- **Description**: 一款 Ant Design 设计风格的 VuePress 主题。（Github 镜像库，有问题请前往 Github 反馈！！！）
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://antdocs.pages.dev
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 2
- **Created**: 2020-03-01
- **Last Updated**: 2024-09-27

## Categories & Tags

**Categories**: site-theme

**Tags**: None

## README

<p align="center"><a href="https://github.com/zpfz/vuepress-theme-antdocs" target="_blank" rel="nofollow"><img width="120" src="https://s2.ax1x.com/2020/02/27/3aIcDK.png" alt="AntDocs logo"></a></p>

<h2 align="center">AntDocs</h2>

<p align="center">An Ant Design style theme for VuePress.</p>

<p align="center">
  <img src="https://img.shields.io/badge/build-passing-brightgreen?style=flat-square" alt="Build Status">
  <img src="https://img.shields.io/npm/dt/vuepress-theme-antdocs?style=flat-square&color=red" alt="Downloads">
  <img src="https://img.shields.io/github/package-json/v/zpfz/vuepress-theme-antdocs?style=flat-square" alt="Version">
  <img src="https://img.shields.io/github/license/zpfz/vuepress-theme-antdocs?style=flat-square" alt="License">
</p>

# Features
- Equipped with Ant Design style, you can directly use various components of the UI library.
- Optimize parts of styles.
- More features are waiting for you to discover ...

# Quick start

#### Install theme

```sh
npm i vuepress-theme-antdocs
```
or
```sh
yarn add vuepress-theme-antdocs
```

#### Use theme  

Open your `.vuepress/config.js`, and then add VuePress theme reference code:
```js
module.exports = {
  theme: 'antdocs'
}
```
You can get help here: [Using a theme](https://vuepress.vuejs.org/theme/using-a-theme.html#theme-shorthand)

# Preview

<p align="center"><img src="https://s2.ax1x.com/2020/02/28/3B3lOf.png"/></p>