Render Docs from README.md files

[hoegertn]

The project itself and all the folders and subfolder of src/ contain README.md files. These can be used to generate a structured documentation website.

This website could then be built and hosted by GH pages.

Tasks:

• [ ] create build script to collect README.md files and render static HTML
• [ ] create GH actions workflow to use that script and prepare GH pages
• [ ] configure GH pages to deploy using this workflow

[hoegertn]

Any ideas?

[mbonig]

I've used docusaurus before for this sort of thing...

[dbartholomae]

For TypeScript, I've used typedoc in the past which also creates nice documentation out of JSDoc comments. Here's an example: https://dbartholomae.github.io/middy-middleware-jwt-auth/

The benefit of getting automated documentation from JSDoc is paid for though by being uglier and less feature-rich than e.g. Docusaurus