/react-doc

Primary LanguageBatchfile

                                                 _.-"\
                                            _.-"      \
                                          ,-"          \
                                          \    create    \
                                          \ \    react    \
                                          \ \      doc     \
                                            \ \         _.-;
                                            \ \    _.-"   :
                                              \ \,-"    _.-"
                                              \(   _.-"
                                                `--"

npm version week download views views clones LICENSE MIT

Create React Doc

Create React Doc 是一个使用 React 的 markdown 文档站点生成工具。就像 create-react-app 一样，开发者可以使用 Create React Doc 来开发、部署 markdown 站点或者博客而无需关心站点环境配置信息。

特性

  • 建站理念: 文件即站点 (Files as a site)。
  • 开箱即用: 一键生成可运行文档站点, 无需关心站点环境配置信息。
  • 自定义展示目录: 天然适合搭建 monorepo 文档、博客等站点。
  • 性能: 文档支持懒加载提升站点加载速度。
  • 工作流: 集成 Github action, 自动化打包、发布站点。

快速上手

主题

当前默认使用的主题是 crd-seed。

使用该主题搭建的站点

如果你的产品从中受益，欢迎留言补充

快速上手

create-react-doc 非常容易上手。开发者不需要额外安装或配置 webpack 或者 Babel 等工具，它们被内置隐藏在脚手架中，因此开发者可以专心于文档的书写。

如果你想在当前文件下建立站点文件 doc, 这里提供如下三种方式快速建站:

npx

npx create-react-doc doc

npm

npm init create-react-doc doc

yarn

yarn create react-doc doc

如果想把模板内容内容拉取到当前文件夹, 则可以将如上命令的 doc 替换为 ., 比如执行 npx create-react-doc .。

接着执行 cd doc && yarn && yarn start, 可以在 localhost: 3000 预览站点, 如果站点文档发生改变, 站点将自动重新加载。

高阶用法

与 git 文件结构类似, 如果在展示的文件夹中有私有文件不方便展示在文档站点, 可以在 .gitignore 文件中设置过滤文件, 这样它们就不会展示在文档站点中了。eg: .gitignore

其它工具