{"id":13795031,"url":"https://github.com/YvesCoding/rcpress","last_synced_at":"2025-05-12T21:33:09.620Z","repository":{"id":57180695,"uuid":"194256671","full_name":"YvesCoding/rcpress","owner":"YvesCoding","description":"基于react和Ant Design的文档生成器 🎨","archived":false,"fork":false,"pushed_at":"2023-01-22T08:05:32.000Z","size":4253,"stargazers_count":193,"open_issues_count":15,"forks_count":26,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-11-08T13:40:40.431Z","etag":null,"topics":["ant-design","documentation","gatsby","gatsby-theme","react"],"latest_commit_sha":null,"homepage":"https://www.yvescoding.com/rcpress/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/YvesCoding.png","metadata":{"files":{"readme":"README-en_US.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-28T10:40:30.000Z","updated_at":"2024-07-12T22:31:05.000Z","dependencies_parsed_at":"2023-02-12T15:02:18.377Z","dependency_job_id":null,"html_url":"https://github.com/YvesCoding/rcpress","commit_stats":null,"previous_names":["yvescoding/antdsite","yvescoding/gatsby-theme-ant-docs"],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YvesCoding%2Frcpress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YvesCoding%2Frcpress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YvesCoding%2Frcpress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YvesCoding%2Frcpress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YvesCoding","download_url":"https://codeload.github.com/YvesCoding/rcpress/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225157000,"owners_count":17429698,"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":["ant-design","documentation","gatsby","gatsby-theme","react"],"created_at":"2024-08-03T23:00:51.376Z","updated_at":"2024-11-18T09:31:35.788Z","avatar_url":"https://github.com/YvesCoding.png","language":"JavaScript","funding_links":[],"categories":["Site Generators"],"sub_categories":[],"readme":" \u003cp align=\"center\"\u003e\u003ca href=\"https://www.yvescoding.com/rcpress/\"\u003e\u003cimg width=\"100\" src=\"https://www.yvescoding.com/rcpress/favicon.png\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eRcPress\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\nA static website generator build with Ant Design and powered by React.js. 🎨\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@rcpress/core\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@rcpress/core.svg\" alt=\"Version\"\u003e\u003c/a\u003e\u003ca href=\"https://circleci.com/gh/YvesCoding/rcpress/tree/master\"\u003e\u003cimg src=\"https://circleci.com/gh/YvesCoding/rcpress/tree/master.png?style=shield\" alt=\"Build Status\"\u003e\u003c/a\u003e \n  \u003ca href=\"https://www.npmjs.com/package/@rcpress/core\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/@rcpress/core.svg\" alt=\"License\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/@rcpress/core\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/@rcpress/core.svg\" alt=\"Download\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/YvesCoding/rcpress\"\u003e\u003cimg src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square\" alt=\"prettier\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n[![](https://github.com/wangyi7099/pictureCdn/blob/master/allPic/rcpress/screenshot-readme.png?raw=true)](https://www.yvescoding.com/rcpress/)\n\n[Chinese](./README.md) | English\n\n## Introduction\n\n- Rcpress is a static document generator based on react.js.\n- The document is made by imitating ant design [official website](https://ant.design/)\n- Function configuration is to imitate [vuepress](https://vuepress.vuejs.org/)\n\n## What is the difference between rcpress and vuepress?\n\n|                      |              |                         |\n| :------------------: | :----------: | :---------------------: |\n|                      | **vuepress** |       **rcpress**       |\n|      Framework       |     vue      |          react          |\n|          UI          | vue theme ui |       Ant Design        |\n|     Custom theme     |      ✅      |           ✅            |\n|    service worker    |      ✅      |           ✅            |\n|         pwa          |      ✅      |           ✅            |\n|  Custom theme color  |      ❌      | ✅(Ant Design build-in) |\n|      hot reload      |      ✅      |           ✅            |\n|        Plugin        |      ✅      |           ❌            |\n|   ssr in dev mode    |      ❌      |           ✅            |\n|     build to spa     |      ❌      |           ✅            |\n| generate static html |      ✅      |           ✅            |\n|   jsx in markdown    |      ✅      |         ✅(mdx)         |\n\n## Features\n\n- It only needs a simple configuration and some markdown knowledge to get started quickly. Users who are familiar with [Vuepress](https://rcpress.vuejs.org/) are more comfortable to use.\n- Supports rendering to common Ant Design components using markdown syntax, such as [Alert](https://www.yvescoding.com/rcpress/guide/markdown#prompt-box)\n- Support [mdx](https://github.com/mdx-js/mdx), support [custom layout](https://www.yvescoding.com/rcpress/guide/theme#custom-layout) (eg custom website header, bottom, home page, etc.)\n\n## Documentation\n\nFor detailed docs, recommend to visit [guide section](https://www.yvescoding.com/rcpress/guide/getting-started) on the website.\n\n## Usage\n\nInstall command line tool `@rcpress/cli`\n\n```bash\n\nyarn global add @rcpress/cli\n\n# or if you use npm\n\nnpm i  @rcpress/cli -g\n\n```\n\nCreate diretory and markdown file\n\n```bash\n# create docs diretory(docs is the default documentation directory)\nmkdir docs\n\n# create a markdown file\necho '# Hello RcPress' \u003e docs/README.md\n\n```\n\nRun server\n\n```bash\n# start spa mode server\nrcpress dev\n# start ssr mode server\nrcpress server\n\n# Visit `3000` port and that's all.\n```\n\nBuild\n\n```bash\n# build spa in production\nrcpress build\n# build ssr and generate static html files in production\nrcpress generate\n```\n\n## Homepage Screenshot\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://www.yvescoding.com/rcpress/screenshot.png\" width=\"700\" /\u003e\n\u003c/p\u003e\n\n## Thanks\n\n- [Ant Design](https://ant.design/)\n- [VuePress](https://rcpress.vuejs.org/)\n- [GatsbyJs](https://www.gatsbyjs.org/)\n\n## WeChat Communication\n\nThere are more than 100 members in the group, add my WeChat, I will invite you to the communication group.\n\n \u003cimg src=\"https://github.com/wangyi7099/pictureCdn/blob/master/allPic/vuescroll/wx.png?raw=true\" width=\"400\" alt=\"Demo\" style=\"max-width:100%;\"\u003e\n\n## License\n\n**MIT** By Yves Wang(Wangyi Yi)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYvesCoding%2Frcpress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FYvesCoding%2Frcpress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYvesCoding%2Frcpress/lists"}