Files

Chris Johnston 88e6244075 Add release version to docs footer, Add doc build instructions (#963 )

* Add guide for building the docs

* Add version to the footer of the docs

* fix links for readme

* change formatting of doc build readme

* proper capitalization of DocFX in readme

* Remove code tags around version

2018-03-24 12:28:50 -04:00

api

Coerce docfx into building API documentation

2017-04-03 15:51:17 -04:00

guides

[docs] Change 'Echos' to 'Echoes' (#964 )

2018-02-24 16:01:28 -05:00

.gitignore

Clean up commands documentation; index

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

CONTRIBUTING.md

Restructure documentation layout

2017-04-03 16:37:44 -04:00

docfx.json

Add release version to docs footer, Add doc build instructions (#963 )

2018-03-24 12:28:50 -04:00

filterConfig.yml

Coerce docfx into building API documentation

2017-04-03 15:51:17 -04:00

index.md

Rewrite all concepts documentation

2017-04-03 18:46:00 -04:00

README.md

Add release version to docs footer, Add doc build instructions (#963 )

2018-03-24 12:28:50 -04:00

toc.yml

Restructure documentation layout

2017-04-03 16:37:44 -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.
(Optional) If you intend to target a specific version, ensure that you have the correct version checked out.
Build the library. Run dotnet build in the root of this repository. Ensure that the build passes without errors.
Build the docs using docfx .\docs\docfx.json. Add the --serve parameter to preview the site locally. Some elements of the page may appear incorrect when not hosted by a server.
- Remarks: According to the docfx website, this tool does work on Linux under mono.