ReactiveUI documentation and guidelines website. PR's welcome! 💖
MIT License
This is the source code for the ReactiveUI website. It's a static site generated by DocFx.
Steps
the DocFx tool dotnet tool update -g docfx
the Nuke tool dotnet tool install Nuke.GlobalTool --global
Open command prompt at the repository root folder, ensure that you have installed the DocFx tool and then run docfx reactiveui/docfx.json --serve
Hit Ctrl-C to exit
localhost:8080
To build the entire Website we use Nuke Build
you will need to install the tool so that you can run command line nuke commands using dotnet tool install Nuke.GlobalTool --global
.
Once installed from the command prompt execute Nuke
this will download and build the sources for the API section of the website, this takes around 35 minutes to compile and build the website with the API sections.
Once complete you can either execute docfx reactiveui/docfx.json --serve
to run the site OR Nuke BuildWebsite
to build the API only.
If you have generated the API section and wish to remove it on your local machine to enable the website to compile faster, run nuke clean
and then run docfx reactiveui/docfx.json --serve