Skip to content

Lucianing/antdsite

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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)

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 35.8%
  • CSS 33.1%
  • TypeScript 31.1%