{"id":13725073,"url":"https://github.com/jaredly/redoc","last_synced_at":"2025-04-14T21:52:41.631Z","repository":{"id":66952892,"uuid":"126662642","full_name":"jaredly/redoc","owner":"jaredly","description":"A clean \u0026 easy documentation generator for reason/bucklescript/ocaml","archived":false,"fork":false,"pushed_at":"2019-01-20T02:07:15.000Z","size":23141,"stargazers_count":115,"open_issues_count":17,"forks_count":11,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-28T10:01:42.199Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://jaredforsyth.com/redoc/index.html","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/jaredly.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"Roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-25T03:51:56.000Z","updated_at":"2024-12-27T00:02:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"1f133ae0-512a-4700-98ee-1161bcfbcaaf","html_url":"https://github.com/jaredly/redoc","commit_stats":{"total_commits":238,"total_committers":3,"mean_commits":79.33333333333333,"dds":0.008403361344537785,"last_synced_commit":"c5e746bccdb068641971373874a97e851af92307"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredly%2Fredoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredly%2Fredoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredly%2Fredoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaredly%2Fredoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaredly","download_url":"https://codeload.github.com/jaredly/redoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248968759,"owners_count":21191158,"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":[],"created_at":"2024-08-03T01:02:11.818Z","updated_at":"2025-04-14T21:52:41.608Z","avatar_url":"https://github.com/jaredly.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\n# Redoc\n\nA clean \u0026 easy documentation generator for reason/bucklescript/ocaml.\n\nCheck out the generated docs at https://jaredforsyth.com/redoc.\n\n## How to use:\n\nget the binary (either by [downloading it](https://github.com/jaredly/redoc/releases/), or building it yourself).\n\nTo build:\n\n```bash\nnpm install\nnpm start\n```\n\nThe binary is then in `./lib/bs/native/main.native`. You can run `./redoc.sh`, which delegates to that.\n\n### Common options\n\n```txt\n  --root (default: current directory)\n      expected to contain bsconfig.json, and bs-platform in the node_modules\n  --target (default: {root}/docs)\n      where we should write out the docs\n  --name (default: the name of the directory, capitalized)\n      what this project is called\n  --ignore-code-errors\n      don't print warnings about parse \u0026 type errors in code blocks\n  --ml\n      assume code snippets are in ocaml syntax, not reason\n  -h, --help\n      print this help\n```\n\n### Less used options\n\n```txt\n  --project-file (can be used multiple times)\n      specified as /abs/path/to/.cmt:rel/path/from/repo/root\n  --project-directory (can be used multiple times)\n      path/to/cmt/directory:rel/path/from/root\n  --dependency-directory (can be used multiple times)\n      a directory containing \".cmj\" files that should be '-I'd when compiling snippets\n  --bs-root (default: root/node_modules/bs-platform)\n  --skip-stdlib-completions\n      don't include completions for the stdlib in the playground\n  --no-bundle\n      don't bundle the code examples. This disables editor support\n  --just-input\n      just parse the options \u0026 show the debug output of parsing cli args\n  --debug\n      output debugging information\n```\n\n\n## Related work\n\nhttp://davidchristiansen.dk/drafts/final-pretty-printer-draft.pdf\n\nooh check this out\nhttps://github.com/martinklepsch/cljdoc\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredly%2Fredoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaredly%2Fredoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaredly%2Fredoc/lists"}