Documentation

The SVG.js docs are built upon Kirby with the KDoc theme.

Requirements

You'll need:

  • PHP 5.4+
  • Node.js

Getting started

  1. Download or clone the svgdotjs.github.io repo and switch to the source-2.7 branch.

  2. Run npm install. This is only required the first time.

  3. Run npm run serve -s which will open up your default browser with the docs running.

Writing

Log in to Kirby on localhost:8027/panel using username svgjs and password svgjs.

The text editors in Kirby are Markdown and Kirbytext enabled.

Pull Requests

If you're not a core collaborator on svgdotjs, fork the source-2.7 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

  1. Go to localhost:8027/statify.php in a web browser to run the build. The static files will be generated in a folder called 2.7 at the root of the repo.

  2. Move the 2.7 folder out of the repo.

  3. Commit and push the changes in the source-2.7 branch and switch to the master branch.

  4. Replace the /docs/2.7 folder in the master branch with the newly generated 2.7 folder.

  5. Commit and push the changes in the master branch and you're done!
Fork me on GitHub