{"id":15688388,"url":"https://github.com/transitive-bullshit/update-markdown-jsdoc","last_synced_at":"2025-05-07T08:28:34.507Z","repository":{"id":32432763,"uuid":"133557590","full_name":"transitive-bullshit/update-markdown-jsdoc","owner":"transitive-bullshit","description":"Updates a markdown document section with jsdoc documentation.","archived":false,"fork":false,"pushed_at":"2022-12-09T07:03:51.000Z","size":1740,"stargazers_count":8,"open_issues_count":17,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-02T01:03:54.066Z","etag":null,"topics":["documentation","jsdoc","markdown","readme"],"latest_commit_sha":null,"homepage":null,"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/transitive-bullshit.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}},"created_at":"2018-05-15T18:33:47.000Z","updated_at":"2024-06-17T03:21:59.000Z","dependencies_parsed_at":"2023-01-14T21:11:34.932Z","dependency_job_id":null,"html_url":"https://github.com/transitive-bullshit/update-markdown-jsdoc","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transitive-bullshit%2Fupdate-markdown-jsdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transitive-bullshit%2Fupdate-markdown-jsdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transitive-bullshit%2Fupdate-markdown-jsdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transitive-bullshit%2Fupdate-markdown-jsdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/transitive-bullshit","download_url":"https://codeload.github.com/transitive-bullshit/update-markdown-jsdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252841916,"owners_count":21812569,"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":["documentation","jsdoc","markdown","readme"],"created_at":"2024-10-03T17:59:11.797Z","updated_at":"2025-05-07T08:28:34.460Z","avatar_url":"https://github.com/transitive-bullshit.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# update-markdown-jsdoc\n\n\u003e Updates a markdown document section with jsdoc documentation.\n\n[![NPM](https://img.shields.io/npm/v/update-markdown-jsdoc.svg)](https://www.npmjs.com/package/update-markdown-jsdoc) [![Build Status](https://travis-ci.com/transitive-bullshit/update-markdown-jsdoc.svg?branch=master)](https://travis-ci.com/transitive-bullshit/update-markdown-jsdoc) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\nThis CLI allows you to quickly generate and update quality readme JSDoc documentation.\n\nHere is an [example](https://github.com/transitive-bullshit/puppeteer-github) of the generated docs. Note that the `API` section is auto-generated, whereas the rest of the readme is editable like normal.\n\n## Install\n\n```bash\nnpm install -g update-markdown-jsdoc\n```\n\n## Usage\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n## Related\n\n-   [update-markdown-usage](https://github.com/transitive-bullshit/update-markdown-usage) - Same as this module but for CLI programs instead of jsdoc libraries.\n-   [documentation.js](https://github.com/documentationjs/documentation) - JSDoc documentation generator which this module is based on.\n-   [jsdoc](http://usejsdoc.org/) - JSDoc documentation standard.\n\n## License\n\nMIT © [Travis Fischer](https://transitivebullsh.it)\n\nSupport my OSS work by \u003ca href=\"https://twitter.com/transitive_bs\"\u003efollowing me on twitter \u003cimg src=\"https://storage.googleapis.com/saasify-assets/twitter-logo.svg\" alt=\"twitter\" height=\"24px\" align=\"center\"\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransitive-bullshit%2Fupdate-markdown-jsdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftransitive-bullshit%2Fupdate-markdown-jsdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransitive-bullshit%2Fupdate-markdown-jsdoc/lists"}