{"id":18441586,"url":"https://github.com/stefanwalther/docker-jsdoc2md","last_synced_at":"2026-05-10T03:04:37.609Z","repository":{"id":28251199,"uuid":"104584811","full_name":"stefanwalther/docker-jsdoc2md","owner":"stefanwalther","description":"Docker image to run jsdoc2md (jsdoc-to-markdown).","archived":false,"fork":false,"pushed_at":"2025-04-01T11:36:53.000Z","size":85,"stargazers_count":1,"open_issues_count":14,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T20:12:00.420Z","etag":null,"topics":["api-documentation","docker-image","docker-jsdoc2md","documentation","jsdoc-to-markdown","jsdoc2md","markdown"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/stefanwalther.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-23T17:11:54.000Z","updated_at":"2022-12-07T12:52:31.000Z","dependencies_parsed_at":"2023-01-14T08:28:13.809Z","dependency_job_id":"34711cb6-3109-4160-b197-7405854e8c80","html_url":"https://github.com/stefanwalther/docker-jsdoc2md","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/stefanwalther%2Fdocker-jsdoc2md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanwalther%2Fdocker-jsdoc2md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanwalther%2Fdocker-jsdoc2md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanwalther%2Fdocker-jsdoc2md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stefanwalther","download_url":"https://codeload.github.com/stefanwalther/docker-jsdoc2md/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248932697,"owners_count":21185369,"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":["api-documentation","docker-image","docker-jsdoc2md","documentation","jsdoc-to-markdown","jsdoc2md","markdown"],"created_at":"2024-11-06T06:38:39.834Z","updated_at":"2026-05-10T03:04:32.570Z","avatar_url":"https://github.com/stefanwalther.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docker-jsdoc2md\n\n\u003e Docker image to run jsdoc2md (jsdoc-to-markdown).\n\n[![CircleCI](https://img.shields.io/circleci/project/github/stefanwalther/docker-jsdoc2md.svg)](https://circleci.com/gh/stefanwalther/docker-jsdoc2md/tree/master)\n\n## Motivation\n\n## Run\n\n```sh\n$ docker run --rm -v ${PWD}:/opt/jsdoc2md stefanwalther/jsdoc2md \"source-files\" \u003e \"output\"\n```\n\n### Run as npm script\n\nA very convenient approach is to just add a script to your `package.json` file:\n\n```js\n\"scripts\": {\n    \"api-docs\": \"docker run --rm -v ${PWD}:/opt/jsdoc2md stefanwalther/jsdoc2md ./src/index.js \u003e ./docs/api-docs.md\"\n}\n```\nThis would convert all the jsdoc information from `./src/index.js` and create a file `./docs/api-docs.md`.\n\n## Configuration\n\n## Installation\n\n### Prerequisites\n\n- [Docker for Mac](https://docs.docker.com/docker-for-mac/) / [Docker for Windows](https://docs.docker.com/docker-for-windows/)\n\n## Known Issues\n\n... none known so far ...\n\n## Changelog\n\nSee [CHANGELOG file](CHANGELOG.yml)\n\n## About\n\n### Author\n\n**Stefan Walther**\n\n* [stefanwalther.io](http://stefanwalther.io)\n* [qliksite.io](http://qliksite.io)\n* [github/stefanwalther](https://github.com/stefanwalther)\n* [Twitter](http://twitter.com/waltherstefan)\n* [LinkedIn](https://www.linkedin.com/in/stefanwalther/)\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/stefanwalther/docker-jsdoc2md/issues). The process for contributing is outlined below:\n\n1. Create a fork of the project\n2. Work on whatever bug or feature you wish\n3. Create a pull request (PR)\n\nI cannot guarantee that I will merge all PRs but I will evaluate them all.\n\n### License\nCopyright © 2017, [Stefan Walther](http://qliksite.io).\n \nMIT\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefanwalther%2Fdocker-jsdoc2md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstefanwalther%2Fdocker-jsdoc2md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefanwalther%2Fdocker-jsdoc2md/lists"}