You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Setting up DocFX and GitHub Pages for a library mod
Warning
This doc no longer represents best practices for docfx + pages management. I have retained it for posterity but would instead
recommend that readers consult the DocFX QuickStart which contains information about
installing and using the tool and publishing to GitHub pages.
Intro
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.