@rcpress/core v0.2.9

English | 简体中文

Introduction

• Rcpress is a static document generator based on react.js.
• The document is made by imitating ant design official website
• Function configuration is to imitate vuepress

What is the difference between rcpress and vuepress?

• Rcpress is driven by react.js, while vuepress is driven by Vue.
• Rcpress uses ant design as the UI framework, while vuepress uses a custom style.

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

yarn global add @rcpress/cli

# or if you use npm

npm i  @rcpress/cli -g

Usage

Create diretory and markdown file

# create docs diretory(docs is the default documentation directory)
mkdir docs

# create a markdown file
echo '# Hello RcPress' > docs/README.md

Run server

# start spa mode server
rcpress dev
# start ssr mode server
rcpress server

# Visit `3000` port and that's all.

Build

# build spa in production
rcpress build
# build ssr and generate static html files in production
rcpress generate

Homepage Screenshot

Thanks

• Ant Design
• VuePress
• GatsbyJs

WeChat Communication

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

License

MIT By Yves Wang(Wangyi Yi)