Create React Doc 是一个使用 React 的 markdown 文档站点生成工具。就像 create-react-app 一样，开发者可以使用 Create React Doc 来开发、部署 markdown 站点或者博客而不用关心站点环境配置信息。
特性零配置书写 markdown 文档站点。
markdown 文档支持懒加载以及热加载。
基于文件目录自动生成多层级菜单。
支持一键发布到 GitHub Pages.
使用 create-react-doc 搭建的文档站点blog
执行如下命令:
npx create-react-doc my-doc npm install && cd my-doc npm start然后打开 :3000/ 就可以看到文档站点。当准备发布到生产环境时，执行 npm run build 就能将文档站点打包压缩。
使用create-react-doc 非常容易上手。开发者不需要额外安装或配置 webpack 或者 Babel 等工具，它们被内置隐藏在脚手架中，因此开发者可以专心于文档的书写。
下面提供三种方式来快速创建文档站点:
npx npx create-react-doc my-doc npm npm init create-react-doc my-doc yarn yarn create create-react-doc my-doc一旦安装执行完毕，执行 npm install 然后进入项目文件夹:
npm install && cd my-doc在新创建的项目中, 可以执行内置的一些命令:
npm start or yarn start在开发者模式下启动文档项目:
在浏览器中打开 :3000 预览站点。
如果站点文档发生改变, 站点将自动重新加载。
npm run build or yarn build将要发布的文档站点进行打包构建, 此时的文档网站已准备好进行部署。
npm run deploy or yarn deploy根据 里的 user 和 repo 参数, 文档站点默认将会发布到 GitHub Pages
config.yml可以在站点根目录中的 config.yml 文件夹 中进行配置站点的功能。
# Site title title: Time Flying # Point witch files to show as Menu ## you can also set detailed dir, such as BasicSkill/css menu: React,BasicSkill,Algorithm ## set init open menu keys menuOpenKeys: /BasicSkill # Github ## if you want to show editing pages on github or deploy to GitHub Pages, you should config these arguments. user: MuYunyun repo: blog branch: master # the default value of branch is master deploy_branch: gh-pages # which branch to deploy.(default: gh-pages) # publish: # if you want upload to gitlab or other git platform, you can set full git url in it # Available values: en| zh-cn language: en 高阶用法与 git 文件结构类似, 如果在展示的文件夹中有私有文件不方便展示在文档站点, 可以在 .gitignore 文件中设置过滤文件, 这样它们就不会展示在文档站点中了。eg: .gitignore