rcpress- 基于React的文档生成器

前言

以前开发vue组件时,写文档使用的是vuepress,之后转战react后觉得没有顺手的文档生成工具,就模仿vuepress写了这个rcpress。

特点

  • RcPress 是一个基于 React.js 的静态文档生成器。
  • 文档UI是模仿 ant design 官网
  • 功能配置模仿Vuepress
  • 支持mdx,可以在markdown中使用jsx。
  • 支持service worker。
  • 生产模式下支持生成静态html页面和打包spa两种模式。
  • 开发模式下支持ssr,spa两种模式。

技术栈

快速上手

安装

安装命令行工具 @rcpress/cli

yarn global add @rcpress/cli

# 或者如果你用npm

npm i  @rcpress/cli -g

用法

创建目录以及markdown文件

# 创建 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的对比

首先说下不同点

  • rcpress 使用了 react.js 驱动,而 vuepress 是由 vue 驱动的。
  • rcpress 是使用了 Ant Design 作为 UI 框架,而 vuepress 是使用了自定义的样式。

说下欠缺的功能

  • 没有plugin(插件)这个概念,当然以后可以考虑加入。

说下优势

  • 可以在文档里使用所有ant design的组件,不用自己写。
  • 支持在开发模式下运行spa,ssr两种模式。vuepress貌似只能运行spa模式。
  • 支持生产spa打包。

相关链接

原文链接:segmentfault.com

上一篇:element的el-table中记录滚动条位置
下一篇:活动倒计时实践与思考

相关推荐

  • 高频数据交换下Flutter与ReactNative的对比

    (标题图片来自网络,侵删) 后端使用go写的socketio服务模拟期货行情数据,每10ms推送10条行情数据 ReactNative已经尽力优化了。 Flutter由于没fluttersock...

    2 年前
  • 高性能迷你React框架 anu1.3.0 发布

    anujs1.3.0是一款高性能Reactlike框架,是目前世界上对React16兼容最好的迷你库。 自React16起,相继推出createContext,createPortal, creat...

    2 年前
  • 高德地图 react-amap 实战

    clipboard.png(https://img.javascriptcn.com/5a33946ad8c0ea8ee7870f74f331d0c0 "clipboard.png") reacta...

    9 个月前
  • 高品质 React UI 组件

    (https://img.javascriptcn.com/cca319311c2ea59a2b5cdaa63b997828)(https://link.funteas.com?target=http...

    2 年前
  • 骚操作!在react中使用vuex

    原文地址(https://github.com/zyl1314/blog/issues/12) 前言 笔者最近在学习使用,提到react就绕不过去。redux是一个状态管理架构,被广泛用于rea...

    2 年前
  • 项目文档说明:react + Ant Design 的 blog-react-admin

    效果图(https://img.javascriptcn.com/734ce56fe3a37ab11e9744473f56bae1 "效果图") 前言 此 blogreactadmin 项目是基...

    2 年前
  • 面试题:Hooks 与 React 生命周期的关系

    React 生命周期很多人都了解,但通常我们所了解的都是 单个组件 的生命周期,但针对 Hooks 组件、多个关联组件(父子组件和兄弟组件) 的生命周期又是怎么样的喃?你有思考和了解过吗,接下来我们将...

    10 个月前
  • 面试官:请你在React中引入Vue3的@vue/reactivity,实现响应式。

    前言 React的状态管理是一个缤纷繁杂的大世界,光我知道的就不下数十种,其中有最出名immutable阵营的redux,有mutable阵营的mobx,reacteasystate,在hooks诞生...

    4 个月前
  • 面试官我想做个Reacter(React路由)

    路由的基础用法回顾,源码study,文章首发于docs,求个star 依赖 路由依赖于 reactrouter ,但是一般 pc 路由使用 reactrouterdom ,它依赖于 reactrout...

    3 个月前
  • 面试中React与Vue的比对

    1.virtual dom 用JS模拟DOM结构,DOM变化的对比,放在JS层做,以提高重绘性能 DOM操作昂贵,JS运行效率高,要减少DOM操作 使用:snabbdom的使用 ...

    2 年前

官方社区

扫码加入 JavaScript 社区