preface

Introduction to the

AntdSite(Ant Design Of Site) is a document generator driven by GatsbyJs based on Ant Design.

The basic requirement for using it is markdown syntax.

origin

I used to be a user of Vuepress and felt very comfortable using it to document in the development of vue components. Later, I began to study React. Developing react components requires documentation. During this period, I tried several document generators based on React, such as Docz and Docusaurus. But I tried it out and it didn’t work as well as Vuepree. Later, when I visited the Ant Design website, an idea occurred to me: Would it be ok to make the Ant Design website configurable? The answer is yes. Antdsite was born.

In summary:

  • The configuration of the document mimics the configuration of Vuepress.
  • The interface Design of the document is from the Ant Design website.
  • Basically the Ant Design website, I made it configurable and made it more powerful!

The characteristics of

  • Configuration similar to VuePress. Easy to get started. All you need is a basic knowledge of Markdown and a little JS to get started.
  • You can write it in markdownjsxAnd can be used directly insideallAnt Design components. Reference Documents:Use the JSX
  • Support custom part layout, such as header, tail, home page, etc. Supports custom layout. Reference: Customize themes

Quick start

Quickly initialize a project using the CLI


yarn global add antdsite-cli

# or if you use NPM

npm i antdsite-cli -g


antdsite my-docs
Copy the code

Then access the local port 8000.

Run a screenshot

Q&A

Is this the same configuration as vuePress?

Most are modeled after the configuration of Vuepress, but there are some differences. For example, there is no custom port, address,PWA, etc. Those that need to configure Gatsby are more complicated to AntdSite.

Can I use React?

Absolutely. Start with markdown basics and a little JS knowledge.

Can I publish custom themes to NPM as plug-ins?

This is not available for now, but it could be added in the future.

If you have any questions, please leave a comment

Write in the last

  • Making the address
  • website