Documentation is kept close to the code that it documents, this means we have documentation in most Cratis repositories. The documentation is then added as Git sub modules. Check out this repository using the following:
git clone --recursive https://github.com/cratis/Documentation.gitIf you have already cloned it without recursive sub modules, you can initialize it using the following:
git submodule update --init --recursiveTo pull the latest from all the repositories:
git submodule update --init --remote --recursiveSometimes, updating submodules leave them in a detached HEAD state, to you can then run:
git submodule foreach 'git checkout main && git pull'To get started with local development, navigate to the Source folder and run yarn restore. This will make sure all NPM and NuGet packages, including
tools are restored.
Then all you need to do is run yarn watch and after build and the Web server has started navigate to http://localhost:8080.
It will watch for any changes and rebuild and restart the web server after this.
Everything is configured through the docfx.json file, documentation for the file can be found here.
We've configured using the SingulinkFX template.