From f265e303492c91269d14504f4cd084c20b3b56d5 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Sat, 24 Feb 2018 15:46:43 +0100 Subject: [PATCH] Add guide for building the docs --- docs/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..b98573f75 --- /dev/null +++ b/docs/README.md @@ -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]