Cwa-documentation: Use a static site generator for better UX

[squidfunk]

I'm the author and maintainer of Material for MkDocs, a theme for the static site generator MkDocs which generates a static site from a set of Markdown files. The UX is much better than browsing GitHub pages, it includes a client-side search, TOC and great mobile UX. There are also features like callouts, tabbed content, footnotes, syntax highlighting and many more.

It's also already used by SAP.

I'm happy to help and can submit a PR. Otherwise feel free to close this issue.

[MalteJ]

We are currently working on a website for this open source project. Probably we will start with a simple static site without embedded docs, but we plan to integrate this in the future.
So thanks a lot for this offer!
I will keep this issue open and come back to you as soon as we are working on the docs integration.

[squidfunk]

Awesome! Happy to assist.

[SebastianWolf-SAP]

OK, it took a while.. In the meantime, our website repo went live and we also made some extensions to it.

Unfortunately, our first approach to an automated integration of the respective markdown documents from cwa-documentation resulted in some issues (especially with tables and references) which we couldn't resolve with a reasonable amount of resources. As a consequence, we will continue linking the most important documents, but don't continue working on an automated integration of the markdown files and will therefore also close this issue.

However, in case somebody wants to contribute a fully working integration, PRs to cwa-website are always welcome.

Thanks for your understanding.

Mit freundlichen Grüßen/Best regards,
SW
Corona Warn-App Open Source Team

[MalteJ]

We could also open a features/docs branch so you can provide small increments, work together with other helping hands and don't need to fix the whole documentation thing with just one pull request.