Instructions for Building Documentation
The documentation for the Discord.Net library uses DocFX.
Instructions for installing this tool can be found here.
- Navigate to the root of the repository.
- (Optional) If you intend to target a specific version, ensure that
you have the correct version checked out.
- Build the docs using
docfx docs/docfx.json
. Add the --serve
parameter to preview the site locally. Some elements of the page
may appear incorrect when not hosted by a server.
- Remarks: According to the docfx website, this tool does work on
Linux under Mono.