{"id":14969962,"url":"https://github.com/muyunyun/create-react-doc","last_synced_at":"2025-05-16T13:03:14.382Z","repository":{"id":37655980,"uuid":"268011830","full_name":"MuYunyun/create-react-doc","owner":"MuYunyun","description":"📝 Minimalistic React-powered static site generator.","archived":false,"fork":false,"pushed_at":"2025-05-11T02:00:20.000Z","size":18393,"stargazers_count":178,"open_issues_count":8,"forks_count":19,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-11T12:01:50.554Z","etag":null,"topics":["blog","cli","markdown","prerender","react","react-doc","ssr"],"latest_commit_sha":null,"homepage":"http://muyunyun.cn/create-react-doc","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MuYunyun.png","metadata":{"files":{"readme":"README-en.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["http://muyunyun.cn/sponsor/"]}},"created_at":"2020-05-30T04:55:03.000Z","updated_at":"2025-02-19T14:27:15.000Z","dependencies_parsed_at":"2024-04-16T02:30:10.902Z","dependency_job_id":"c7b2101c-9610-4351-91fb-9a957903bb67","html_url":"https://github.com/MuYunyun/create-react-doc","commit_stats":{"total_commits":2,"total_committers":1,"mean_commits":2.0,"dds":0.0,"last_synced_commit":"36c56cecb7ae5711890c16c570c5d86cf929da67"},"previous_names":[],"tags_count":94,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuYunyun%2Fcreate-react-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuYunyun%2Fcreate-react-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuYunyun%2Fcreate-react-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MuYunyun%2Fcreate-react-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MuYunyun","download_url":"https://codeload.github.com/MuYunyun/create-react-doc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254535826,"owners_count":22087398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blog","cli","markdown","prerender","react","react-doc","ssr"],"created_at":"2024-09-24T13:42:46.211Z","updated_at":"2025-05-16T13:03:14.355Z","avatar_url":"https://github.com/MuYunyun.png","language":"JavaScript","readme":"                                                     _.-\"\\\n                                                _.-\"      \\\n                                              ,-\"          \\\n                                              \\    create    \\\n                                              \\ \\    react    \\\n                                              \\ \\      doc     \\\n                                                \\ \\         _.-;\n                                                \\ \\    _.-\"   :\n                                                  \\ \\,-\"    _.-\"\n                                                  \\(   _.-\"\n                                                    `--\"\n\n[![npm version](https://img.shields.io/npm/v/create-react-doc)](https://badge.fury.io/js/create-react-doc)\n[![week download](https://img.shields.io/npm/dw/create-react-doc.svg)](https://www.npmjs.com/package/create-react-doc)\n![views](https://raw.githubusercontent.com/MuYunyun/create-react-doc/traffic/traffic-create-react-doc/views.svg)\n![views](https://raw.githubusercontent.com/MuYunyun/create-react-doc/traffic/traffic-create-react-doc/views_per_week.svg)\n![clones](https://raw.githubusercontent.com/MuYunyun/create-react-doc/traffic/traffic-create-react-doc/clones_per_week.svg)\n![LICENSE MIT](https://img.shields.io/npm/l/create-react-doc.svg)\n\nEnglish | [简体中文](./README.md)\n\n# Create React Doc\n\n[Create React Doc](https://github.com/MuYunyun/create-react-doc) is a markdown document site generation tool using React just like [create-react-app](https://github.com/facebook/create-react-app), developers can use Create React Doc to develop, deploy documents or blog sites without worrying about additional environment configuration information.\n\n## Features\n\n* The idea of ​​building a site: Just write markdown files as a blog site [like me](https://github.com/MuYunyun/blog).\n* Out of box: One-click generation of documents and blog sites by specifying directories or documents, no need to care about site environment configuration information.\n* Performance: greatly improve site loading speed through pre-rendering and lazy loading.\n* Based on mdx: Support writing React components, mathematical formulas, etc. in markdown.\n* Search engine optimization: Support SEO, making documents easier to search.\n* Personalization: Support [custom theme](https://muyunyun.cn/create-react-doc/9f41fc98).\n* Workflow: Integrate Github actions, support automated packaging and publishing sites.\n\n\u003e [Quick Start](https://muyunyun.cn/create-react-doc/290a4219)\n\n## Subject\n\nCreate React Doc provides the official default theme [crd-seed](https://github.com/MuYunyun/create-react-doc/tree/main/packages/crd-seed). The theme supports the following features:\n\n* Adapt to mobile and PC multi-terminal display.\n* Support dark mode.\n* The document supports embedded codepen, codesandbox.\n* GitHub linkage.\n* Support using tags to customize aggregate article content.\n\n[my blog](http://muyunyun.cn/blog) is based [crd-seed](https://github.com/MuYunyun/create-react-doc/tree/main/packages/crd-seed) theme to build。\n\n![](http://with.muyunyun.cn/90d3e357a31649b9466a828a92b6d88d.jpg)\n![](http://with.muyunyun.cn/2e7440e4256debda2d73a4e6392c7146.jpg-300)\n\nIf you want to customize or share personal themes, you can refer to the [Custom Theme](https://muyunyun.cn/create-react-doc/9f41fc98) chapter.\n\n## Get started quickly\n\n**Create React Doc** is very easy to use. Developers don't need to install or configure additional tools such as webpack or Babel, they are built-in and hidden in the scaffolding, so developers can concentrate on document writing.\n\nIf you want to create a site file `doc` under the current file, here are three ways to quickly build a site:\n\n### npx\n\n```bash\nnpx create-react-doc doc\n```\n\n### npm\n\n```bash\nnpm init create-react-doc doc\n```\n\n### yarn\n\n```bash\nyarn create react-doc doc\n```\n\n![](http://with.muyunyun.cn/0f0cf6e8cb68b18399eac2927f74b063.jpg)\n\n\u003e If you want to pull the content of the template to the current folder, you can replace the `doc` of the above command with `.`, such as executing `npx create-react-doc .`.\n\nThen execute `cd doc \u0026\u0026 yarn \u0026\u0026 yarn start`, you can preview the site at `localhost: 3000`, if the site document changes, the site will automatically reload.\n\n\u003cimg src=\"http://with.muyunyun.cn/2bbd4d8da3165e1a09a88f5e6a114009.jpg\" width=\"900\" /\u003e\n\n## Site release\n\nIn the [Quick Start](http://muyunyun.cn/create-react-doc/QuickStart) section, it introduces how to quickly build a site. This section will introduce how to package and publish the built site to gh-pages.\n\n### Automatically package and publish to gh-pages (recommended)\n\nThe initialized template project integrates the [ci configuration](https://github.com/MuYunyun/create-react-doc/blob/main/packages/templates/default/.github/workflows/gh-pages.yml) of `Github action`, the user only needs to execute `git push` on the main branch to complete the automatic deployment of the site.\n\n![](http://with.muyunyun.cn/ea24d511f76efe5ba5d13bb6b1609aac.jpg)\n\nIf it is the first deployment, after performing the following operations, you need to select Github Pages as gh-pages in the setting tab of the project. (See [First Deployment with GITHUB_TOKEN](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token) for details)\n\n```bash\ngit init\ngit add.\ngit commit -m \"first commit\"\ngit branch -M main\ngit remote add origin https://github.com/user or organization name/project name.git\ngit push -u origin main\n```\n\n\u003e For more content, please visit [Site Release](http://muyunyun.cn/create-react-doc/SiteRelease), [Advanced Usage](http://muyunyun.cn/create-react-doc/HighOrderusage), [other tools](http://muyunyun.cn/create-react-doc/othertools) and other chapters.\n\n## Practice Sharing\n\n* [基于 SSR 的预渲染首屏直出方案](http://muyunyun.cn/blog/g3v1c5bq)\n* [SEO 在 SPA 站点中的实践](http://muyunyun.cn/blog/ettzfags)\n","funding_links":["http://muyunyun.cn/sponsor/"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuyunyun%2Fcreate-react-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuyunyun%2Fcreate-react-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuyunyun%2Fcreate-react-doc/lists"}