Files

Quin Lynch c1641f12fc Update v2->v3 guide and index page (#2039 )

* Update v2->v3 guide and index

* Fix format on save fail

* Update index.md

* Update discord widget id

* Fix formatting

2022-01-14 07:55:17 -04:00

_overwrites

V3 Final merge (#1966 )

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

_template

V3 Final merge (#1966 )

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

api

Documentation Overhaul (#1161 )

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

faq

Update FAQ & Migration guide to include Intents (#1987 )

2021-12-22 11:04:08 -04:00

guides

Update v2->v3 guide and index page (#2039 )

2022-01-14 07:55:17 -04:00

marketing/logo

Update package banner link (#1986 )

2021-12-22 09:52:04 -04:00

.gitignore

Clean up commands documentation; index

2016-07-22 13:08:26 -04:00

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

meta: bump version

2021-12-24 16:12:36 -04:00

favicon.ico

docs: Documentation December Update (#1218 )

2018-12-28 08:49:02 -08:00

filterConfig.yml

docs: Main docs update (#1304 )

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

index.md

Update v2->v3 guide and index page (#2039 )

2022-01-14 07:55:17 -04:00

langwordMapping.yml

Documentation Overhaul (#1161 )

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

README.md

Documentation Overhaul (#1161 )

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

toc.yml

V3 Final merge (#1966 )

2021-12-13 04:47:54 -04: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.

Navigate to the root of the repository.
Build the docs using docfx docs/docfx.json. Add the --serve parameter 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.