These instructions describe how to set up DocFX and publish documentation as a static website to your repository's GitHub Pages. They are targeted at Hollow Knight modders and use some conventions that have been generally adopted in the Hollow Knight modding community, but should be generally applicable to other types of projects as well.
As a note before we begin, much of this content has room for preferential variation. In general, this documentation assumes the following:
- You have an existing C# project that you want to add docs to (i.e. you are not starting from scratch) and that your project is in the the default C# project layout (solution in its own folder, csproj's nested one level deeper alongside their contents).
- You want your documentation in a folder named
docsinside the top-level solution directory, and will document only one project in