Feature: command for rebuilding docs

[toebeann]

From citkane/typedoc-plugin-versions#13

Summary

At present, after a while of using this plugin, it is possible to end up in a position where you have old docs built with entirely different styles, themes, plugins etc. to your latest docs build. This could make browsing older docs feel quite inconsistent. On top of that, as typedoc itself updates, it may change the way it renders certain things, and on later runs you might change your typedoc configs to be inconsistent with earlier doc builds. Presently, the only way to deal with this is to manually checkout your older version, update typedoc, install any plugins including themes, change the config, etc.

It would be very nice to be able to automate this process, and for this automation to be usable via GitHub workflows and package.json scripts. Therefore, a CLI tool fits the bill, and is relatively simple to achieve via the package.json bin field.

Details

• rely on git tags as semantic versions. check them out, and update typedoc/install plugins/update config as necessary
• optional argument to specify versions to rebuild docs for, ideally should be possible to specify ranges and use wildcards etc. By default should rebuild only the docs for versions that are currently built
• optional arguments to specify typedoc version, and plugins and their versions, config options, etc.
• ideally, it should also be possible to set arguments in typedoc config file. arguments passed at the CLI should take precedence