You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 765 B

12345678910111213141516
  1. # Instructions for Building Documentation
  2. The documentation for the Discord.Net library uses [DocFX][docfx-main].
  3. [Instructions for installing this tool can be found here.][docfx-installing]
  4. 1. Navigate to the root of the repository.
  5. 2. (Optional) If you intend to target a specific version, ensure that
  6. you have the correct version checked out.
  7. 3. Build the docs using `docfx docs/docfx.json`. Add the `--serve`
  8. parameter to preview the site locally. Some elements of the page
  9. may appear incorrect when not hosted by a server.
  10. - Remarks: According to the docfx website, this tool does work on
  11. Linux under Mono.
  12. [docfx-main]: https://dotnet.github.io/docfx/
  13. [docfx-installing]: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html