The SVG.js docs are built upon Kirby with the KDoc theme.
- PHP 5.4+
Download or clone the svgdotjs.github.io repo and switch to the
npm install. This is only required the first time.
npm run serve -swhich will open up your default browser with the docs running.
Log in to Kirby on localhost:8030/panel using username svgjs and password svgjs.
The text editors in Kirby are Markdown and Kirbytext enabled.
If you're not a core collaborator on svgdotjs, fork the
source-3.0 branch, make the required changes in Kirby following the same style as the rest of the docs, and create a PR. We will take care of the rest, so no need to build or include a static version.
Building the static version
Go to localhost:8030/statify.php in a web browser to run the build. The static files will be generated in a folder called
3.0at the root of the repo.
3.0folder out of the repo.
Commit and push the changes in the
source-3.0branch and switch to the
/docs/3.0folder in the
masterbranch with the newly generated
- Commit and push the changes in the
masterbranch and you're done!