Documentation is an integral part of any project. This template is a good starting point for your documentation. The template uses Mkdocs, a static site generator to convert your markdown files into HTML and host it on github pages.
Here is how you can use it after creating your repository from the template repository:
-
All content in the /docs folder will be converted to HTML by MkDocs
-
Follow the Automate Mkdocs deployment on GitHub Pages using OpenShift Pipelines tutorial to setup a tekton pipeline to deploy your documentation site.
-
You can add/edit your documentation in the /docs folder and commit the changes to the GitHub repository.
-
The documentation will be automatically deployed as a static site on GitHub Pages.
-
Link to access the documentation will automatically get updated in the About section of the Repository.