{"id":21832684,"url":"https://github.com/tool3/rex","last_synced_at":"2026-04-11T20:45:21.642Z","repository":{"id":38998401,"uuid":"280502207","full_name":"tool3/rex","owner":"tool3","description":"🦖 create docs site from README file using docusaurus","archived":false,"fork":false,"pushed_at":"2023-02-03T22:16:49.000Z","size":7937,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-01-26T09:27:13.729Z","etag":null,"topics":["docs","docusaurus2","javascript"],"latest_commit_sha":null,"homepage":"https://drex.netlify.app/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tool3.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2020-07-17T18:52:40.000Z","updated_at":"2024-10-17T13:52:07.000Z","dependencies_parsed_at":"2023-02-15T06:01:49.904Z","dependency_job_id":null,"html_url":"https://github.com/tool3/rex","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tool3%2Frex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tool3%2Frex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tool3%2Frex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tool3%2Frex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tool3","download_url":"https://codeload.github.com/tool3/rex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244807278,"owners_count":20513607,"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":["docs","docusaurus2","javascript"],"created_at":"2024-11-27T19:24:57.218Z","updated_at":"2026-04-11T20:45:16.592Z","avatar_url":"https://github.com/tool3.png","language":"JavaScript","readme":"\u003c!--{\"title\": \"Welcome\", \"main\": true}--\u003e\n\n# rex\n\n[![](https://img.shields.io/static/v1?label=created%20with%20rex\u0026message=%F0%9F%A6%96\u0026color=1e1e1e)](https://drex.netlify.app)   \n\ndocusaurus based README docs generator.  \nseperate your readme to different pages using `\u003c!-- {json metadata} --\u003e`.  \nsee this README in [edit](https://github.com/tool3/rex/edit/master/README.md) mode.\n\n# automagic\n\nrex can create the doc site without any manual editing of the `README` file.  \nit defaults to a page per main header (e.g 1 `#`), \nwithout any grouping in the docs sidebar (flat).\n\n# use JSON\n\nuse HTML comments with json to structure your doces.  \nFor example:\n`\u003c!-- { \"title\": \"rex\", \"category\": \"About\", \"main\": true } --\u003e` will generate a doc with title rex and a new sidebar dropdown will be created with the name About.\n\n\u003e Note that when you write this in your `.md` files be sure to have no space between the `\u003c!--` and `{` (same is true for `}` and `--\u003e`)\n\n\u003c!--{\"title\": \"Run\", \"category\": \"Getting Started\"}--\u003e\n\n# Run\n\nThe easiest way to get started with `rex` is to clone the repo, and copy your `README` file to the root directory.\nOnce done, run the `create.js` file:\n\n```bash\nnpm run create\n```\n\nThe steps performed in `create.js` include:\n\n- create documents in the `docs/` directory from your README.\n- map category to documents.\n- update `sidebars.js` with the doc to category mapping.\n- update `docusaurus.config.js` with the main docs page (defaults to the first page).\n\n\u003c!--\n:::danger\nRunning `create.js` will replace all of the content in the `docs/` directory,\nas well as blindly override the `sidebars.js` file.\n:::\n\n--\u003e\n\n\u003c!--{\"title\": \"Post Actions\", \"category\": \"Getting Started\"}--\u003e\n\n# Post Actions\n\nafter running the `create.js` file, new docs will now be located under the `docs` directory.  \nhere are some steps to consider after running `create`:\n\n- update logos and title in `docusaurus.config.js` file\n- update theme color `--ifm-color-primary` in `./src/css/custom.css`\n- add a rex badge to show your support: `[![](https://img.shields.io/static/v1?label=created%20with%20rex\u0026message=%F0%9F%A6%96\u0026color=1e1e1e)](https://drex.netlify.app)`\n\u003c!--{\"title\": \"Options\", \"category\": \"Getting Started\"}--\u003e\n\n# Options\n\nthe options you can supply `rex` are as follows:\n\n### title\n\nthis will become the document title\n\n### category\n\nthis will group together documents in the docs sidebar\n\n### main\n\nset this only once - the main docs page.  \ndefaults to the first page\n\nfor example:\n\n```json\n{ \"title\": \"Welcome\", \"main\": true }\n```\n\nwill create the default page for the `Docs` tab.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftool3%2Frex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftool3%2Frex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftool3%2Frex/lists"}