Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/YvesCoding/rcpress
基于react和Ant Design的文档生成器 🎨
https://github.com/YvesCoding/rcpress
ant-design documentation gatsby gatsby-theme react
Last synced: 24 days ago
JSON representation
基于react和Ant Design的文档生成器 🎨
- Host: GitHub
- URL: https://github.com/YvesCoding/rcpress
- Owner: YvesCoding
- License: other
- Created: 2019-06-28T10:40:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-22T08:05:32.000Z (almost 2 years ago)
- Last Synced: 2024-11-08T13:40:40.431Z (about 1 month ago)
- Topics: ant-design, documentation, gatsby, gatsby-theme, react
- Language: JavaScript
- Homepage: https://www.yvescoding.com/rcpress/
- Size: 4.06 MB
- Stars: 193
- Watchers: 15
- Forks: 26
- Open Issues: 15
-
Metadata Files:
- Readme: README-en_US.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-docs - RcPress
README
RcPress
A static website generator build with Ant Design and powered by React.js. 🎨
[](https://www.yvescoding.com/rcpress/)
[Chinese](./README.md) | English
## Introduction
- Rcpress is a static document generator based on react.js.
- The document is made by imitating ant design [official website](https://ant.design/)
- Function configuration is to imitate [vuepress](https://vuepress.vuejs.org/)
## What is the difference between rcpress and vuepress?
| | | |
| :------------------: | :----------: | :---------------------: |
| | **vuepress** | **rcpress** |
| Framework | vue | react |
| UI | vue theme ui | Ant Design |
| Custom theme | ✅ | ✅ |
| service worker | ✅ | ✅ |
| pwa | ✅ | ✅ |
| Custom theme color | ❌ | ✅(Ant Design build-in) |
| hot reload | ✅ | ✅ |
| Plugin | ✅ | ❌ |
| ssr in dev mode | ❌ | ✅ |
| build to spa | ❌ | ✅ |
| generate static html | ✅ | ✅ |
| jsx in markdown | ✅ | ✅(mdx) |
## Features
- It only needs a simple configuration and some markdown knowledge to get started quickly. Users who are familiar with [Vuepress](https://rcpress.vuejs.org/) are more comfortable to use.
- Supports rendering to common Ant Design components using markdown syntax, such as [Alert](https://www.yvescoding.com/rcpress/guide/markdown#prompt-box)
- Support [mdx](https://github.com/mdx-js/mdx), support [custom layout](https://www.yvescoding.com/rcpress/guide/theme#custom-layout) (eg custom website header, bottom, home page, etc.)
## Documentation
For detailed docs, recommend to visit [guide section](https://www.yvescoding.com/rcpress/guide/getting-started) on the website.
## Usage
Install command line tool `@rcpress/cli`
```bash
yarn global add @rcpress/cli
# or if you use npm
npm i @rcpress/cli -g
```
Create diretory and markdown file
```bash
# create docs diretory(docs is the default documentation directory)
mkdir docs
# create a markdown file
echo '# Hello RcPress' > docs/README.md
```
Run server
```bash
# start spa mode server
rcpress dev
# start ssr mode server
rcpress server
# Visit `3000` port and that's all.
```
Build
```bash
# build spa in production
rcpress build
# build ssr and generate static html files in production
rcpress generate
```
## Homepage Screenshot
## Thanks
- [Ant Design](https://ant.design/)
- [VuePress](https://rcpress.vuejs.org/)
- [GatsbyJs](https://www.gatsbyjs.org/)
## 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)