title | _description |
---|---|
Build Docs Locally |
How to build Riptide's documentation locally on your computer. |
Building the documentation site locally on your computer can be useful in a variety of situations, such as when you wish to preview changes you've made.
Riptide uses DocFX to build its documentation. To install DocFX, open a terminal and run the following command:
dotnet tool install -g docfx --version 2.70.1
Once DocFX is installed:
- Navigate to the
Docs
folder in your cloned Riptide repository. - Run
docfx docfx.json --serve
. - Visit http://localhost:8080/ in your web browser.