JSDoc publishing 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!
With 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. - Tutorials <https://ugate.github.io/jsdocp/tutorial-1-start.html> - API Docs <https://ugate.github.io/jsdocp/global.html> Features: *Page customizations:* - *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 - Branded documentation using your own logo - Add your own CSS, JavaScript and meta to the documentation pages without altering the chosen template *Versioned documentation:* - 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 - 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!) - 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 *CHANGELOG generation:* - Each time docs are tagged/deployed a CHANGELOG.md as well as a markdown parsed CHANGELOG.html are generated (optional) - 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 - 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*) *Documentation deployment:* - Page deployment execution via Node.js cli <https://nodejs.org/api/cli.html> from the command line or via the provided API - Easy integration in continuous integration services like travis-ci <https://travis-ci.com/>, etc. *Markdown extensions:* - Include preprocessed source files into any of your tutorial pages by simply adding... ```jsdocp path/to/my/project/file.js // contents of file.js will appear below this comment and the language will be set using the file extension! ``` >> Check out the Tutorials <https://ugate.github.io/jsdocp/tutorial-1-start.html> to get started (also generated by jsdocp) -- Job board: http://jobs.nodejs.org/ New group rules: https://gist.github.com/othiym23/9886289#file-moderation-policy-md Old group rules: https://github.com/joyent/node/wiki/Mailing-List-Posting-Guidelines --- You received this message because you are subscribed to the Google Groups "nodejs" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/nodejs/CAE37u1%3DN9UaYkRR5hM3vAROaRr65390Nuj13D3pJMfPcAK4NWw%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
