# Deploying the documentation site
The rendered documentatipon is deployed to Github pages. The process has been automated and can be run with:
npm run docs:deploy
If you are interested in the details, the deploy process has been defined in
package.json docs:deploy
script and looks like this:
- Compile the typescript codebase
- Run the test suite
- Build the vuepress documentation
- Create a new git repo in the
docs/.vuepress/dist
folder and commit all created files - Push the repo to
master:gh-pages
branch