Skip to content
A static website generator build with Ant Design and driven by gatsby.js. 🎨
JavaScript CSS TypeScript
Branch: master
Clone or download
wangyi7099 Publish
 - antdsite@0.12.10
 - docs@0.7.10
Latest commit aea4c0f Sep 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci ci: tweak deployment order. Aug 26, 2019
packages Publish Sep 8, 2019
.editorconfig docs build Aug 2, 2019
.eslintignore docs build Aug 2, 2019
.eslintrc.js docs build Aug 2, 2019
.gitignore tweak Aug 2, 2019
.prettierrc chore: tweak readme Aug 4, 2019
CHANGELOG.md docs: add set themeColors feature. Aug 5, 2019
README-zh_CN.md chore: readme Aug 27, 2019
README.md chore: readme Aug 27, 2019
lerna.json chore: change lerna.json Jul 29, 2019
package.json fix: no locales and base is not / Sep 8, 2019
yarn.lock feat(antdsite): add markdown syntax of alert component Aug 24, 2019

README.md

AntdSite

A static website generator build with Ant Design and driven by gatsby.js

VersionBuild Status License Download prettier

English | 简体中文

Introduction

  • AntdSite is a static website generator based on React.js.
  • It's driven by Gatsby Js
  • It is built with Ant Design and its configuration style borrows from Vuepress.

Features

  • It only needs a simple configuration and some markdown knowledge to get started quickly. Users who are familiar with Vuepress are more comfortable to use.
  • Supports rendering to common Ant Design components using markdown syntax, such as Alert
  • Support mdx, support custom layout (eg custom website header, bottom, home page, etc.)

Documentation

For detailed docs, recommend to visit guide section on the website.

Install

Install command line tool antdsite-cli

yarn global add antdsite-cli

# or if you use npm

npm i antdsite-cli -g

Usage

Initialize a default starter project via antdsite-cli

antdsite my-docs

Visit 8000 port and that's all.

Homepage Screenshot

Todo List

  • Support highlighting the specified line of code
  • A global component that can display the demo

Thanks

WeChat Communication

There are more than 100 members in the group, add my WeChat, I will invite you to the communication group.

Demo

License

MIT By Yves Wang(Wangyi Yi)

You can’t perform that action at this time.