{"id":13536040,"url":"https://github.com/jaywcjlove/rdoc","last_synced_at":"2025-08-15T20:44:16.818Z","repository":{"id":65479590,"uuid":"115743310","full_name":"jaywcjlove/rdoc","owner":"jaywcjlove","description":"⚛️📄🚀 Fast static site generator for React, Just write Markdown file. @react-doc","archived":false,"fork":false,"pushed_at":"2024-04-22T23:27:35.000Z","size":536,"stargazers_count":155,"open_issues_count":11,"forks_count":22,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-06-30T17:05:49.891Z","etag":null,"topics":["content-management-system","markdown","rdoc","react","react-doc","static-site-generator"],"latest_commit_sha":null,"homepage":"https://git.io/rdoc","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/jaywcjlove.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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},"funding":{"github":"jaywcjlove","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":"npm/rdoc","community_bridge":null,"custom":"https://jaywcjlove.github.io/sponsor.html"}},"created_at":"2017-12-29T18:00:08.000Z","updated_at":"2025-05-26T04:00:47.000Z","dependencies_parsed_at":"2023-01-25T08:25:18.361Z","dependency_job_id":"6e8f6a01-b3c5-473f-9ecb-a53c76763ddb","html_url":"https://github.com/jaywcjlove/rdoc","commit_stats":{"total_commits":202,"total_committers":2,"mean_commits":101.0,"dds":0.004950495049504955,"last_synced_commit":"3acef410703bed45296a83b11dd161181a3c95ad"},"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"purl":"pkg:github/jaywcjlove/rdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Frdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Frdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Frdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Frdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaywcjlove","download_url":"https://codeload.github.com/jaywcjlove/rdoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaywcjlove%2Frdoc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264570386,"owners_count":23629789,"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":["content-management-system","markdown","rdoc","react","react-doc","static-site-generator"],"created_at":"2024-08-01T09:00:34.008Z","updated_at":"2025-07-14T16:05:31.723Z","avatar_url":"https://github.com/jaywcjlove.png","language":"JavaScript","funding_links":["https://github.com/sponsors/jaywcjlove","https://tidelift.com/funding/github/npm/rdoc","https://jaywcjlove.github.io/sponsor.html"],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://react-doc.github.io\"\u003e\n    \u003cimg width=\"150\" src=\"theme/default/rdoc.logo.svg?sanitize=true\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nrdoc\n---\n\n[![Join the chat at https://gitter.im/j-rdoc/Lobby](https://badges.gitter.im/j-rdoc/Lobby.svg)](https://gitter.im/j-rdoc/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge) [![](https://img.shields.io/github/issues/jaywcjlove/rdoc.svg)](https://github.com/jaywcjlove/rdoc/issues) [![](https://img.shields.io/github/forks/jaywcjlove/rdoc.svg)](https://github.com/jaywcjlove/rdoc/network) [![](https://img.shields.io/github/stars/jaywcjlove/rdoc.svg)](https://github.com/jaywcjlove/rdoc/stargazers) [![](https://img.shields.io/github/release/jaywcjlove/rdoc.svg)](https://github.com/jaywcjlove/rdoc/releases) [![jaywcjlove/sb](https://jaywcjlove.github.io/sb/lang/chinese.svg)](README_zh.md)\n\nBlazing-fast static site generator for React, Just write Markdown file. Visit the [react-doc.github.io](https://react-doc.github.io) website for more information.\n\n\u003e The documentation site is also a demo [example](https://react-doc.github.io).\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./rdoc.png\"\u003e \n\u003c/div\u003e\n\n## Getting Started\n\nIt's really easy to get started with **rdoc**. Just install it as a module and run it to create your website.\n\nLet's get you started!\n\n### Install\n\nInstall `rdoc` globally on your system. You’ll need to have Node \u003e= 8 on your local development machine. You can use [n](https://github.com/tj/n#installation) to easily switch Node versions between different projects.\n\n```bash\nnpm install rdoc -g\n\n# /usr/local/bin/rdoc -\u003e /usr/local/lib/node_modules/rdoc/.bin/rdoc.js\n# /usr/local/bin/rdoc-cli -\u003e /usr/local/lib/node_modules/rdoc/.bin/rdoc.js\n```\n\nAdded `rdoc-cli` command to resolve Mac integration `rdoc` command conflicts.\n\n1. Init Project\n\n```bash\nrdoc init my-project  # Init project\n# or\nrdoc-cli init my-project \n```\n\n2. Run website\n\n```bash\ncd my-project \u0026\u0026 npm install # Install dependencies.\nnpm start # Into the directory, start the service.\n```\n\n3. Compile output static HTML resources\n\n```bash\nnpm run build\n```\n\n4. Configure the deployment URL in `package.json`\n\n```js\n{\n  \"scripts\": {\n    \"deploy\": \"rdoc --publish \u003cyour repo url\u003e\"\n    ...\n  },\n  ...\n}\n```\n\n5. Deploy to Github's `gh-pages` branch\n\n```bash\nnpm run deploy\n```\n\n### Command\n\n```shell\nUsage: rdoc [options]\n\nFast static site generator for React.\n\nOptions:\n\n  -i, init [path]        Create an empty website or reinitialize an existing one.\n  -d, --doc \u003cpath\u003e       Other documents generated.\n  -o, --output \u003cpath\u003e    Writes the compiled file to the disk directory. (default: .rdoc-dist)\n  -p, --port [number]    The port. (default: 5858)\n  --host [host]      The host. (default: 0.0.0.0)\n  -b, --branch \u003cbranch\u003e  Name of the branch you are pushing to. (default: gh-pages)\n  --publish [url]        Other documents generated.\n  --build                Creating an optimized production build.\n  --clean                Delete the .cache folder.\n  -h, --help             output usage information\n\nExamples:\n\n  $ rdoc init\n  $ rdoc init doc-example\n  $ rdoc -d doc/mm\n  $ rdoc -d tutorial,doc\n  $ rdoc -d tutorial,doc --clean --build\n  $ rdoc -p 2323  -d doc --clean\n  $ rdoc --host 0.0.0.0 -d doc --clean\n  $ rdoc --publish https://\u003cyour-git-repo\u003e.git --branch master\n```\n### Development\n\nTo develop, run the self-reloading build, Get the code:\n\n```shell\n$ git clone https://github.com/jaywcjlove/rdoc.git\n$ cd rdoc     # Into the directory\n$ npm install # or  yarn install\n```\n\nTo develop, run the self-reloading build:\n\n```bash\n# Run the app\n# Restart the app automatically every time code changes. \n# Useful during development.\n$ npm run start\n```\n\nOpen your browser and visit http://localhost:5858\n\n### Folders\n\n```bash\n.\n├── README.md\n├── .rdoc-dist\n├── package.json\n├── src\n│   ├── build.js\n│   ├── commands\n│   ├── conf\n│   ├── publish.js\n│   ├── server.js\n│   ├── utils\n│   └── web\n├── templates\n│   └── default # document the static file.\n└── theme\n    └── default\n```\n\n### License\n\nThe MIT License (MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaywcjlove%2Frdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaywcjlove%2Frdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaywcjlove%2Frdoc/lists"}