All Projects → YvesCoding → Rcpress

YvesCoding / Rcpress

Licence: other
基于react和Ant Design的文档生成器 🎨

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Rcpress

Nord Docs
The official Nord website and documentation
Stars: ✭ 63 (-64.61%)
Mutual labels:  documentation, gatsby
Docs
Repository of Twilio SendGrid's product documentation.
Stars: ✭ 221 (+24.16%)
Mutual labels:  documentation, gatsby
Gatsby Starter Rocket Docs
The documentation starter you were looking for (ready for Gatsby v3) ⚡️
Stars: ✭ 182 (+2.25%)
Mutual labels:  documentation, gatsby
gatsby-wordpress-typescript-scss-blog
Gatsby Wordpress Typescript Blog Boilerplate
Stars: ✭ 50 (-71.91%)
Mutual labels:  gatsby, ant-design
Docz
✍ It has never been so easy to document your things!
Stars: ✭ 22,020 (+12270.79%)
Mutual labels:  documentation, gatsby
Ru.reactjs.org
React documentation website in Russian / Официальная русская версия сайта React
Stars: ✭ 444 (+149.44%)
Mutual labels:  documentation, gatsby
Greenboard
📖 Gatsby theme for api documentation
Stars: ✭ 240 (+34.83%)
Mutual labels:  documentation, gatsby
Awesome Docs With Static Site Generators
Pointers to all templates and implementations based on static site generators
Stars: ✭ 44 (-75.28%)
Mutual labels:  documentation, gatsby
Sentry Docs
The new place for the sentry documentation (and tools to build it)
Stars: ✭ 160 (-10.11%)
Mutual labels:  documentation, gatsby
Opencore Document Zh hans
[非官方/Unofficial] OpenCore Bootloader 参考手册简体中文翻译
Stars: ✭ 169 (-5.06%)
Mutual labels:  documentation
Dynamic Antd Theme
🌈 A simple plugin to dynamic change ant-design theme whether less or css.
Stars: ✭ 174 (-2.25%)
Mutual labels:  ant-design
C4 Builder
This is a documentation builder. You feed it .md and .puml and it exports a site, pdf, or a markdown with navigation.
Stars: ✭ 164 (-7.87%)
Mutual labels:  documentation
Guidelines.spatie.be
The guidelines used at our company
Stars: ✭ 169 (-5.06%)
Mutual labels:  documentation
Abp React Antd
一个基于 ABP + React + Ant Design Pro 的快速开发框架
Stars: ✭ 175 (-1.69%)
Mutual labels:  ant-design
Blog
Code for my personal blog built with Gatsby
Stars: ✭ 167 (-6.18%)
Mutual labels:  gatsby
Apigen
PHP 7.1 ready Smart and Simple Documentation for your PHP project
Stars: ✭ 2,068 (+1061.8%)
Mutual labels:  documentation
Webpack.js.org
Repository for webpack documentation and more!
Stars: ✭ 2,049 (+1051.12%)
Mutual labels:  documentation
Hippie Swagger
API testing tool with automatic swagger assertions
Stars: ✭ 166 (-6.74%)
Mutual labels:  documentation
Jamstack Serverless
Learn JAMstack Serverless Modern App Development in Baby Steps using Gatsby.js, React, TypeScript, GraphQL, Contentful, Netlify, FaunaDB, MongoDB, Apollo, Github Actions, Project Fugu, and CSS Houdini.
Stars: ✭ 178 (+0%)
Mutual labels:  gatsby
Haxemanual
The official Haxe manual
Stars: ✭ 176 (-1.12%)
Mutual labels:  documentation

RcPress

一款使用Ant Design构建,由React.js驱动的静态网站生成器. 🎨

VersionBuild Status License Download prettier

简体中文 | English

简介

  • RcPress 是一个基于 React.js 的静态文档生成器。
  • 界面是模仿 ant-design 官网做的
  • 配置,代码模仿自Vuepress
  • 开发它的目的是我以前是 vuepress 老用户,然后用上 react 后想在 react 里使用它。

用法

安装命令行工具 @rcpress/cli

yarn global add @rcpress/cli

# 或者如果你用npm

npm i  @rcpress/cli -g

创建文件

# 创建 docs 目录(docs是默认的文档目录)
mkdir docs

#创建markdown文件
echo '# Hello RcPress' > docs/README.md

可以运行如下命令

# 启动spa模式的服务
rcpress dev # 推荐
# 启动服务端渲染的服务
rcpress server

# 访问`3000`端口即可。

打包构建

# 在生产环境下构建spa
rcpress build
# 在生产环境下构建ssr并且声称静态html文件
rcpress generate

文档

可以参考官网上的向导一节

与 vuepress 的对比

基本实现了 vuepress 的基础功能

vuepress rcpress
驱动框架 vue react
UI vue 主题 ui Ant Design
自定义主题
service worker
pwa
定制主题颜色 ✅(Ant Design 内置功能)
开发模式 hot reload
插件机制
开发模式下运行 ssr
打包成单页面
打包成静态 html
markdown 中写代码 ✅(mdx)

首页截图

感谢

微信交流

群里成员已经超过 100 人了,添加我的微信我将邀请你到交流群讨论。

Demo

许可证

MIT By Yves Wang(Wangyi Yi)

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].