JSDoc 3 versioned API doc website example

Project serving as an example for using JSDoc 3 and generating a versioned API doc website via GitHub Pages and the Docdash template theme.

Process

A sample documented source code is created in the /src folder of the repository.

At each release creation, a GitHub Action is automatically launched to update the documentation website. This action:

Checkouts the code
Generates the documentation from the jsdoc.conf.json configuration file, using the Docdash template theme and selecting the README.md file of the project as content for the homepage
Pushes the new documentation files into the appropriate docs/vX.X.X folder of the gh-pages website branch
Updates the main page of the API doc website to handle the new release tag