{"id":34735933,"url":"https://github.com/mbroersen/mark-down-my-docs","last_synced_at":"2026-04-07T20:31:04.684Z","repository":{"id":44526158,"uuid":"454054919","full_name":"mbroersen/mark-down-my-docs","owner":"mbroersen","description":"Generates markdown documentation from your js-doc blocks.","archived":false,"fork":false,"pushed_at":"2022-02-23T21:51:22.000Z","size":171,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-23T15:46:33.152Z","etag":null,"topics":["documentation","generator","javascript","jsdoc","markdown","node-js","tsdoc","typescript"],"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/mbroersen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":"mbroersen","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2022-01-31T15:14:11.000Z","updated_at":"2022-02-22T13:24:00.000Z","dependencies_parsed_at":"2022-09-11T14:41:29.770Z","dependency_job_id":null,"html_url":"https://github.com/mbroersen/mark-down-my-docs","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/mbroersen/mark-down-my-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbroersen%2Fmark-down-my-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbroersen%2Fmark-down-my-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbroersen%2Fmark-down-my-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbroersen%2Fmark-down-my-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mbroersen","download_url":"https://codeload.github.com/mbroersen/mark-down-my-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mbroersen%2Fmark-down-my-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31528244,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"ssl_error","status_checked_at":"2026-04-07T16:28:06.951Z","response_time":105,"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","generator","javascript","jsdoc","markdown","node-js","tsdoc","typescript"],"created_at":"2025-12-25T03:34:25.483Z","updated_at":"2026-04-07T20:31:04.678Z","avatar_url":"https://github.com/mbroersen.png","language":"JavaScript","funding_links":["https://patreon.com/mbroersen"],"categories":[],"sub_categories":[],"readme":"# mark-down-my-docs\n[![npm](https://img.shields.io/npm/dt/mark-down-my-docs?style=for-the-badge)](https://www.npmjs.com/package/mark-down-my-docs)\n[![npm](https://img.shields.io/npm/v/mark-down-my-docs?style=for-the-badge)](https://www.npmjs.com/package/mark-down-my-docs)\n\n`MarkDown` generator for `.js` and `.ts` source files with `jsdoc` documentation blocks \n\n## Why?\nI was looking for an out-of-the-box, simple-to-setup documentation generator for a project of mine.\nSo I could easily generate my documentation for this project. \nIt was harder than it sounded, too hard. Turns out that it didn't exist, or I could not find it. That's why I created this package, hope it helps you as much as it helped me.\n\n### These were my demands\n1. Runs right away after installation without extra setup.\n2. Supports typescript and javascript.\n3. Supports jsdoc.\n4. Generates MarkDown files.\n5. Has as few dependencies as possible.\n6. Is fast\n7. Is a node application\n\n## Installation\n```shell\nnpm install mark-down-my-docs \n```\n\n## Usage\nRun command with source directory and docs directory.\n\n```shell\nmark-down-my-docs src/ docs/\n```\n![mark-down-my-docs](./mark-down-my-docs.gif)\n\n## Support\nsupports `.js` and `.ts` files with `js-doc` blocks\n\n`runs on node 14.x and 16.x`\n\n## Suggestions?\n[Please create a new issue](https://github.com/mbroersen/mark-down-my-docs/issues/new)\n\n\n## Example docs generated by `mark-down-my-docs`\n### [View example of docs](./docs/Index.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbroersen%2Fmark-down-my-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmbroersen%2Fmark-down-my-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmbroersen%2Fmark-down-my-docs/lists"}