时间：2023-07-21 08:12:27 点击次数：4
Create React Doc 是一个使用 React 的 markdown 文档站点生成工具。就像 create-react-app 一样，开发者可以使用 Create React Doc 来开发、部署文档或者博客站点而无需关心额外的环境配置信息。
create-react-doc 提供了官方默认主题 crd-seed。该主题支持以下特性:
适配移动、PC 多端展示。支持暗黑模式。文档支持内嵌 codepen、codesandbox。GitHub 联动。使用该主题搭建的项目有:
blog, 站点
diana, 站点
如果您想定制化或者分享个人主题, 可以参考自定义主题章节。
create-react-doc 非常容易上手。开发者不需要额外安装或配置 webpack 或者 Babel 等工具，它们被内置隐藏在脚手架中，因此开发者可以专心于文档的书写。
如果你想在当前文件下建立站点文件 doc, 这里提供如下三种方式快速建站:
如果想把模板内容内容拉取到当前文件夹, 则可以将如上命令的 doc 替换为 ., 比如执行 npx create-react-doc .。接着执行 cd doc && yarn && yarn start, 可以在 localhost: 3000 预览站点, 如果站点文档发生改变, 站点将自动重新加载。
在 快速上手 一节中介绍了如何快速搭建站点, 本节将介绍如何将搭建好的站点打包、发布到 gh-pages。
初始化的模板项目集成了 Github action 的 ci 配置, 使用方只需在 main 分支执行 git push 即可以完成站点的自动部署。
如果是第一次部署, 在执行以下操作后, 需要在项目的 setting 选项卡中将 Github Pages 选择为 gh-pages。(详情见 First Deployment with GITHUB_TOKEN)
git init git add . git commit -m "first commit" git branch -M main git remote add origin https://github.com/用户或组织名/项目名.git git push -u origin main更多内容可以访问 站点发布、高阶用法、其它工具 等章节。
