ellie/Discord.Net
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Discord.Net/docs
History
Toastie 776e2157f5
Added docs
2024-06-13 17:43:59 +12:00
..
_overwrites Added docs 2024-06-13 17:43:59 +12:00
_template Added docs 2024-06-13 17:43:59 +12:00
api Added docs 2024-06-13 17:43:59 +12:00
faq Added docs 2024-06-13 17:43:59 +12:00
guides Added docs 2024-06-13 17:43:59 +12:00
marketing/logo Added docs 2024-06-13 17:43:59 +12:00
.gitignore Added docs 2024-06-13 17:43:59 +12:00
CONTRIBUTING.md Added docs 2024-06-13 17:43:59 +12:00
Discord.Net.Docs.code-workspace Added docs 2024-06-13 17:43:59 +12:00
docfx.json Added docs 2024-06-13 17:43:59 +12:00
favicon.png Added docs 2024-06-13 17:43:59 +12:00
filterConfig.yml Added docs 2024-06-13 17:43:59 +12:00
index.md Added docs 2024-06-13 17:43:59 +12:00
langwordMapping.yml Added docs 2024-06-13 17:43:59 +12:00
README.md Added docs 2024-06-13 17:43:59 +12:00
toc.yml Added docs 2024-06-13 17:43:59 +12: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.76.0 for everything to work correctly.

  1. Navigate to the root of the repository.
  2. 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.