Documentation Website

The documentation website generates a website for your project just like this one. The website is generated and configured using docfx to create a static website with the following contents:

1. A landing page based off the README.md file of your repo.
2. A manual generated from the files and assets specified under the path Documentation\manual in the repo such as this website.
3. A changelog file in the documentation folder at Documentation\changelog.
4. Generated documentation from the XML comments and structure of the C# code.

This website can be generated using Documentation\build.cmd or Documentation/build.sh. This script will first generate the metadata from the XML comments in the code, then generate the website from the configuration provided at Documentation\docfx.json.

You can configure this website however fits best for your project.

The github action deploy.yml will also create a build of the website and upload it to the build via the actions/deploy-pages if you have the environment configured properly.