dc8e0e329d
* [Docs] Get docs working on latest docfx version. Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways. Gotta figure out how to get the description generator and "last modified" plugins to work. * [Docs] Get docs working on latest docfx version. Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways. Gotta figure out how to get the description generator and "last modified" plugins to work. * [Docs] Re-add search index extractor. * [Docs] Use material theme and override derived tree style. Also adds a tiny GitHub icon on the navbar. * [Docs] Exclude DebugTools project. * [Docs] Use better method for overriding things. Totally not because DocFX won't allow me to have an override template. * [Docs] Improve styling overrides. * [Docs] Fix links in FAQs and guides. * [Docs] Use new xref service. The old xref service is being deprecated by the end of the year. See https://github.com/dotnet/docfx/issues/8958 * [Docs] Replace (c) with proper copyright symbol. * [Docs] Fix formatting in docfx.json file. Thanks, VSCode. * [Docs] Remove non-working post processors. They don't work, and *personally* I feel like they're unnecessary considering you can check the last modification date in the (linked) GitHub page. I honestly have no idea what the other post processor does and honestly the code doesn't help much either. * [Docs] Fix "in this article" being too thin. Fixes https://github.com/discord-net/Discord.Net/pull/2778#issuecomment-1748812077 * [Docs] Get examples working again. * [Docs] Make properties be separated more clearly. * [Docs] Change docs index to reflect the new nightly MyGet feed. * [Docs] Get docs working on latest docfx version. Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways. Gotta figure out how to get the description generator and "last modified" plugins to work. * [Docs] Get docs working on latest docfx version. Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways. Gotta figure out how to get the description generator and "last modified" plugins to work. * [Docs] Re-add search index extractor. * [Docs] Use material theme and override derived tree style. Also adds a tiny GitHub icon on the navbar. * [Docs] Exclude DebugTools project. * [Docs] Use better method for overriding things. Totally not because DocFX won't allow me to have an override template. * [Docs] Improve styling overrides. * [Docs] Fix links in FAQs and guides. * [Docs] Use new xref service. The old xref service is being deprecated by the end of the year. See https://github.com/dotnet/docfx/issues/8958 * [Docs] Replace (c) with proper copyright symbol. * [Docs] Fix formatting in docfx.json file. Thanks, VSCode. * [Docs] Remove non-working post processors. They don't work, and *personally* I feel like they're unnecessary considering you can check the last modification date in the (linked) GitHub page. I honestly have no idea what the other post processor does and honestly the code doesn't help much either. * [Docs] Fix "in this article" being too thin. Fixes https://github.com/discord-net/Discord.Net/pull/2778#issuecomment-1748812077 * [Docs] Get examples working again. * [Docs] Make properties be separated more clearly. * [Docs] Change docs index to reflect the new nightly MyGet feed. * [Docs] Fix index image not switching when changing themes. Co-Authored-By: exsersewo <25526843+exsersewo@users.noreply.github.com> * add updated description generator postprocessor * update postprocessor * got it working * downgrade postprocessor docfx * [Docs] Add left margin to side navigation links. * remove dup docs cuz `<inheritdoc />` --------- Co-authored-by: exsersewo <25526843+exsersewo@users.noreply.github.com> Co-authored-by: Misha133 <mihagribkov133@gmail.com> Co-authored-by: Mihail Gribkov <61027276+Misha-133@users.noreply.github.com>
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.
- Build the docs using
docfx docs/docfx.json. Add the--serveparameter to preview the site locally. Some elements of the page may appear incorrectly when hosted offline.
Please note that if you intend to target a specific version, ensure that you have the correct version checked out.