Files

Nora de8da0d3b9 [Docs] Update docfx and remove tocFilter hack. (#3010 )

* Update docfx and remove tocFilter hack.

docfx PR 9912 fixed the TOC filter value not being kept between page loads.
This removes the hack I used to get around it, but keeps the scroll code.

* Update docs workflow.

2024-09-17 20:10:43 +03:00

_overwrites

V3 Final merge (#1966 )

2021-12-13 04:47:54 -04:00

_template

[Docs] Update docfx and remove tocFilter hack. (#3010 )

2024-09-17 20:10:43 +03:00

api

Improve and modernize docs. (#2882 )

2024-03-18 20:39:43 +03:00

faq

[Docs] Switch some images from PNG to SVG (#2939 )

2024-06-02 15:02:48 +03:00

guides

Polls grammar pass (#2964 )

2024-07-21 13:25:28 +03:00

marketing/logo

[Docs] Icon consistency. (#2895 )

2024-03-29 19:01:02 +03:00

.gitignore

…

CONTRIBUTING.md

docs: Main docs update (#1304 )

2019-05-13 18:29:47 -04:00

Discord.Net.Docs.code-workspace

Documentation Overhaul (#1161 )

2018-09-30 17:44:33 -04:00

docfx.json

Meat/3.16.0 (#3003 )

2024-09-14 00:36:12 +03:00

favicon.png

[Docs] Icon consistency. (#2895 )

2024-03-29 19:01:02 +03:00

filterConfig.yml

docs: Main docs update (#1304 )

2019-05-13 18:29:47 -04:00

index.md

[Docs] Updates and tweaks. (#2907 )

2024-04-13 23:23:12 +00:00

langwordMapping.yml

Documentation Overhaul (#1161 )

2018-09-30 17:44:33 -04:00

README.md

[Docs] Update docfx and remove tocFilter hack. (#3010 )

2024-09-17 20:10:43 +03:00

toc.yml

[Feature] Initial user apps support (#2883 )

2024-03-18 21:24:05 +00:00

README.md

Instructions for Building Documentation

The documentation for the Discord.Net library uses DocFX. Instructions for installing this tool can be found here.

Important

You must use DocFX version 2.77.0 for everything to work correctly.

Navigate to the root of the repository.
Build the docs using docfx docs/docfx.json. Add the --serve parameter to preview the site locally.

Please note that if you intend to target a specific version, ensure that you have the correct version checked out.