Installing Wyam Doc Builder
Install Wyam on the command line with
dotnet
(requires .NET Core):dotnet tool install -g Wyam.Tool
Restart command line (or VS Code)
Doc system assumes another copy of repo to
gh-pages
branches has been checked out alongside the repo in agh-pages
directory.Type
wyam
to build, clear all non-.git folders in gh-pages folder before-hand if making significant structure changes.To preview the site and watch for changes use:
wyam -p -w --virtual-dir "/SpaceBattleArena"
Open your browser to http://localhost:5080/SpaceBattleArena/ (notice the ending slash).
Make 2 branches one off
master
and one offgh-pages
in order to submit two PRs for updates to source docs and generated output.