{"id":18370852,"url":"https://github.com/ugate/jsdocp","last_synced_at":"2026-04-18T01:37:54.417Z","repository":{"id":33235340,"uuid":"154550209","full_name":"ugate/jsdocp","owner":"ugate","description":"JSDoc/git publishing agent that generates versioned documentation, CHANGELOGs, auto-deployment to a documentation hosting service (e.g. gh-pages, etc.) and much more!","archived":false,"fork":false,"pushed_at":"2023-04-29T17:27:21.000Z","size":1627,"stargazers_count":2,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T19:15:02.338Z","etag":null,"topics":["continuous-integration","documentation","gh-pages","git","jsdoc","publish","travis-ci"],"latest_commit_sha":null,"homepage":"https://ugate.github.io/jsdocp","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/ugate.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-24T18:37:29.000Z","updated_at":"2021-08-20T16:40:28.000Z","dependencies_parsed_at":"2024-11-05T23:40:47.256Z","dependency_job_id":"13430ce0-5854-4ce6-a168-cdf578406bcc","html_url":"https://github.com/ugate/jsdocp","commit_stats":null,"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ugate%2Fjsdocp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ugate%2Fjsdocp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ugate%2Fjsdocp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ugate%2Fjsdocp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ugate","download_url":"https://codeload.github.com/ugate/jsdocp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248300453,"owners_count":21080734,"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":["continuous-integration","documentation","gh-pages","git","jsdoc","publish","travis-ci"],"created_at":"2024-11-05T23:40:32.305Z","updated_at":"2025-10-10T18:43:38.796Z","avatar_url":"https://github.com/ugate.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cb class=\"jsdocp-remove-me\"\u003e\n  \n# ![](https://raw.githubusercontent.com/ugate/jsdocp/master/jsdocp/static/favicon-32x32.png) \u003cspan style=\"font-size:larger;\"\u003ejsdocp\u003c/span\u003e\n\n[![npm version](https://badgen.net/npm/v/jsdocp?color=orange\u0026icon=npm)](https://www.npmjs.com/package/jsdocp)\n[![Build Status](https://badgen.net/travis/ugate/jsdocp?icon=travis)](https://travis-ci.com/ugate/jsdocp)\n[![Dependency Status](https://badgen.net/david/dep/ugate/jsdocp)](https://david-dm.org/ugate/jsdocp)\n[![Dev Dependency Status](https://badgen.net/david/dev/ugate/jsdocp)](https://david-dm.org/ugate/jsdocp?type=dev)\n\nThe links to the Tutorials and API docs below are examples of what can be generated by `jsdocp`:\n\n![Generated jsdoc/jsdocp pages](https://ugate.github.io/jsdocp/screenshot.png?raw=true \"Example: generated jsdoc/jsdocp pages using minami theme\")\n\n\u003c/b\u003e\n\n### JSDoc publishing\n`jsdocp` is a [`jsdoc`](http://usejsdoc.org/)/[`git`](https://git-scm.com/) publishing agent that generates versioned documentation, CHANGELOGs, auto-deployment to a documentation hosting service (e.g. `gh-pages`, etc.) and much more!\n\nWith `jsdocp` any number of [`jsdoc` templates](https://github.com/jsdoc3/jsdoc#templates) can be used for a personalized experience without the added complexities of setting up your own template extension.\n\n* [Tutorials](https://ugate.github.io/jsdocp/tutorial-1-start.html)\n* [API Docs](https://ugate.github.io/jsdocp/jsdocp.html)\n\n### Features:\n\n\u003e __Page customizations:__\n\u0026nbsp;\n\n- __Use virtually any [JSDoc supported template](https://github.com/jsdoc3/jsdoc#templates)__- adds a responsive navigation bar to the doc pages that contains icons/links to the `npm` module (optional), CHANGELOG (optional), source code (optional) and doc version selection\n- Branded documentation using your own logo\n- Add your own `CSS`, `JavaScript` and `meta` to the documentation pages without altering the chosen template\n\n\u003e __Versioned documentation:__\n\u0026nbsp;\n\n- Each time docs are tagged/deployed to GitHub or any other `git` supported documentation hosting service, the old docs are archived in a versioned directory\n- `versions.json` generation for real-time version selections in previously deployed docs (no more wiping out old docs, and old docs auto-reference an updated set of versions!)\n- Tag filtering option to restrict doc generation for tagged versions that are released for [`major` or `minor` versions](https://semver.org) rather than every version that is tagged\n\n\u003e __CHANGELOG generation:__\n\u0026nbsp;\n\n- Each time docs are tagged/deployed a `CHANGELOG.md` as well as a markdown parsed `CHANGELOG.html` are generated (optional)\n- Customizable CHANGELOG __header__ and __lines__ using markdown, [git formatting](https://git-scm.com/docs/pretty-formats) (e.g. `%h`, etc.) and package/publishing parameter substitutions using [Template Literal](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) syntax\n- Customizable [grep](https://git-scm.com/docs/git-log#git-log---grepltpatterngt) regular expressions for determining which commit messages will appear in the logs (including support for sub-sectioning into __Breaking Changes__, __Features__, __Fixes__ and __Merges/Pull Requests__)\n\n\u003e __Documentation deployment:__\n\u0026nbsp;\n\n- Page deployment execution via [Node.js cli](https://nodejs.org/api/cli.html) from the command line or via the provided API\n- Easy integration in continuous integration services like [travis-ci](https://travis-ci.com/), etc.\n\n\u003e __Markdown extensions:__\n\u0026nbsp;\n\n- Include preprocessed source files into any of your tutorial pages. For example, if we have `path/to/my/project/file.js` that we want to include in a tutorial page that contains:\n```js\nfunction sum(a, b, c) {\n  return a + b + c;\n}\n```\nAnd the following markdown is added to the page:\n\u003cpre\u003e\n```jsdocp path/to/my/project/file.js\n// Lets include some file sources in our docs!\n```\n\u003c/pre\u003e\nThe published docs will contain:\n\u003cpre\u003e\n```js\n// Lets include some file sources in our docs!\nfunction sum(a, b, c) {\n  return a + b + c;\n}\n```\n\u003c/pre\u003e\n\n#### \u003e\u003e Check out the [Tutorials](https://ugate.github.io/jsdocp/tutorial-1-start.html) to get started (also generated by `jsdocp`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fugate%2Fjsdocp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fugate%2Fjsdocp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fugate%2Fjsdocp/lists"}