Browse Source

Cleanup styling of README.md for docs

pull/1161/head
Still Hsu 7 years ago
parent
commit
67eb473326
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
1 changed files with 7 additions and 8 deletions
  1. +7
    -8
      docs/README.md

+ 7
- 8
docs/README.md View File

@@ -1,16 +1,15 @@
# 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]
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 docs using `docfx docs/docfx.json`. Add the `--serve`
2. 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.
may appear incorrectly when hosted offline.

Please note that if you intend to target a specific version, ensure that
you have the correct version checked out.

[docfx-main]: https://dotnet.github.io/docfx/
[docfx-installing]: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
[docfx-installing]: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html

Loading…
Cancel
Save