{"id":15286046,"url":"https://github.com/optimics/monorepodoc","last_synced_at":"2026-05-06T04:32:51.360Z","repository":{"id":37945117,"uuid":"506221828","full_name":"optimics/monorepodoc","owner":"optimics","description":"JSDoc wrapper that generates documentation for each Lerna package","archived":false,"fork":false,"pushed_at":"2022-11-03T09:27:44.000Z","size":1092,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-29T08:41:23.060Z","etag":null,"topics":["documentation","javascript","jsdoc","monorepository","npm","openapi"],"latest_commit_sha":null,"homepage":"","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/optimics.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":"2022-06-22T11:41:26.000Z","updated_at":"2024-01-19T16:30:08.000Z","dependencies_parsed_at":"2023-01-21T12:48:39.875Z","dependency_job_id":null,"html_url":"https://github.com/optimics/monorepodoc","commit_stats":null,"previous_names":["optimics/monorepo-jsdoc"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/optimics/monorepodoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optimics%2Fmonorepodoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optimics%2Fmonorepodoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optimics%2Fmonorepodoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optimics%2Fmonorepodoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/optimics","download_url":"https://codeload.github.com/optimics/monorepodoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optimics%2Fmonorepodoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32678617,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-06T02:33:58.958Z","status":"ssl_error","status_checked_at":"2026-05-06T02:33:39.611Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","javascript","jsdoc","monorepository","npm","openapi"],"created_at":"2024-09-30T15:10:16.524Z","updated_at":"2026-05-06T04:32:51.339Z","avatar_url":"https://github.com/optimics.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# monorepodoc\n\n[![](https://badgen.net/github/checks/optimics/monorepodoc)](https://github.com/optimics/monorepodoc/actions)\n[![](https://badgen.net/github/tag/optimics/monorepodoc)](https://github.com/optimics/monorepodoc/tags)\n[![](https://badgen.net/npm/v/@optimics/monorepodoc)](https://www.npmjs.com/package/@optimics/monorepodoc)\n[![](https://badgen.net/npm/dm/@optimics/monorepodoc)](https://www.npmjs.com/package/@optimics/monorepodoc)\n\nZeroconf [JSDoc](https://jsdoc.app/) wrapper with support for [redoc](https://github.com/Redocly/redoc) and mermaid that generates documentation for each of your monorepo projects and includes READMEs.\n\n## Directories\n\n```\nmonorepo/\n├─ node_modules/      // Always ignored by default\n├─ packages/          // Subpackages are expected here\n│  ├─ docs/           // Markdown files from here are bundled into the docs package\n│  ├─  ├─ anything.md\n│  ├─ specs/\n│  ├─  ├─ index.yaml  // Compiled with redoc and bundled in\n│  ├─ package.json    // Meta information extracted, dependencies linked\n│  ├─ README.md       // Bundled in\n├─ package.json       // Meta information extracted\n├─ README.md          // Bundled in\n```\n\n## Installation\n\n```shell\nnpm install --save-dev @optimics/monorepodoc\n```\n\nSupports only Node.js \u003e= 16\n\n## Running\n\nMonorepodoc will automatically resolve all of your monorepo packages and put build outputs into `dist/docs`.\n\n```shell\nmonorepodoc\n```\n\n## Redoc support\n\nSimply installing [redoc-cli](https://www.npmjs.com/package/redoc-cli) should get your specs automagically bundled.\n\n```\nnpm install --save-dev redoc-cli\n```\n\n## Mermaid support\n\nSimply installing [@mermaid-js/mermaid-cli](https://www.npmjs.com/package/@mermaid-js/mermaid-cli) should get your mermaid charts automagically rendered into PNGs.\n\n```\nnpm install --asve-dev @mermaid-js/mermaid-cli\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptimics%2Fmonorepodoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foptimics%2Fmonorepodoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptimics%2Fmonorepodoc/lists"}