0.0.1 • Published 5 years ago

react-press-docs v0.0.1

Weekly downloads
2
License
ISC
Repository
-
Last release
5 years ago

简体中文 | English

简介

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

用法

安装命令行工具 react-press

yarn global add react-press

# 或者如果你用npm

npm i  react-press -g

创建文件

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

#创建markdown文件
echo '# Hello React-Press' > docs/README.md

可以运行如下命令

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

# 访问`3000`端口即可。

打包构建

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

与 vuepress 的对比

基本实现了 vuepress 的基础功能

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

感谢

0.0.1

5 years ago