Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
1 parent
55299ff
commit 88e6244
Showing
2 changed files
with
18 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Instructions for Building Documentation | ||
|
||
The documentation for the Discord.NET library uses [DocFX][docfx-main]. [Instructions for installing this tool can be found here.][docfx-installing] | ||
|
||
1. Navigate to the root of the repository. | ||
2. (Optional) If you intend to target a specific version, ensure that you | ||
have the correct version checked out. | ||
3. Build the library. Run `dotnet build` in the root of this repository. | ||
Ensure that the build passes without errors. | ||
4. 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. | ||
|
||
[docfx-main]: https://dotnet.github.io/docfx/ | ||
[docfx-installing]: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters