https://github.com/vito24/gatsby-theme-antd-docs

A Gatsby theme helps to build document site like Ant Design quickly.
https://github.com/vito24/gatsby-theme-antd-docs

ant-design docs gatsby gatsby-theme reaact

Last synced: 11 days ago
JSON representation

A Gatsby theme helps to build document site like Ant Design quickly.

• Host: GitHub
• URL: https://github.com/vito24/gatsby-theme-antd-docs
• Owner: vito24
• License: mit
• Created: 2019-08-29T03:36:34.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-10T00:10:31.000Z (over 1 year ago)
• Last Synced: 2024-10-16T05:33:53.055Z (about 1 month ago)
• Topics: ant-design, docs, gatsby, gatsby-theme, reaact
• Language: JavaScript
• Homepage: https://vito24.github.io/gatsby-theme-antd-docs
• Size: 5.05 MB
• Stars: 21
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README-zh_CN.md
  • License: LICENSE

Awesome Lists containing this project

README

        
gatsby-theme-antd-docs




一款 [Gatsby](https://www.gatsbyjs.org/) 主题，方便快速搭建像 [Ant Design](https://ant.design) 这样的文档网站。



[English](./README.md) | 简体中文

## 为什么创建这个项目

[Ant Design](https://ant.design) 拥有一套非常优秀的React组件库，同时，它的网站也十分简洁美观，非常适合用来作为组件库的文档网站。于是，参考 [Ant Design](https://ant.design) 和 [Ant Design Pro](https://pro.ant.design) 的代码，建立了gatsby-theme-antd-theme。

感谢 [Ant Design](https://ant.design) 团队给我们带来的这么优秀的开源作品！

## 特性

- 基于Ant Design的UI设计风格。

- 只需编写markdown文件，自动生成页面。

- 在线预览markdown中的jsx。

## 安装

```bash

yarn add gatsby-theme-antd-docs

```

添加到你的 `gatsby-config.js`

```js

module.exports = {

  plugins: ['gatsby-theme-antd-docs']

}

```

## 本地浏览example

```bash

yarn install

yarn workspace example start

```

打开浏览器访问 http://127.0.0.1:8000

## 🔗 参考链接

- [Gatsby](https://www.gatsbyjs.org/)

- [Ant Design](http://ant.design/)

- [Ant Design Pro](http://pro.ant.design/)