RDoc 是一套基于基于 Webpack,React,React Router 封装的文档生成工具,用于生成React组件库文档或博客网站。RDoc简单到你只需写 Markdown 文件就可以帮助你生成网站,同时可以方便的集成到你的项目工程中。
入门教程
在开始之前,推荐先学习 Markdown语法,并正确安装和配置了 Node.js v8.0 或以上。
全局安装
$ npm install rdoc -g
初始化工程
可以通过一条命令生成,一个初始文档网站工程。初始化工程,里面会包含一个 package.json,rdoc 工具会被当做依赖放入其中,避免 rdoc 工具升级带来的问题。
$ rdoc init my-project
运行网站
初始化工程,其实就是 rdoc 工具的文档,里面 Markdown 都是写好的,直接运行下面命令,可看效果
$ cd my-project
$ npm start
## Compiled successfully!
##
## You can now view rdoc in the browser.
##
## Local: http://localhost:5858/
## On Your Network: http://192.168.188.109:5858/
## Note that the development build is not optimized.
## To create a production build, use npm run build.
会自动打开网站,同时命令行会提示你,打开的网址,这样你就可以开始写 Markdown 了,并且可以实时预览你的网站。
更新日志
修复babel配置排除目录引发的问题以及依赖问题
更新babel preset
更新ESLint配置
∨ 展开