--- getting started
note: this section is only for people who want to contribute to pugl itself.
after cloning the repository, make sure you run
npm install
ln -s ../../pre-commit .git/hooks/
this ensures that your changes are prettified & linted.
the main files of interest are index.html
and pugl.js
, which has all
the JavaScript for pugl (hopefully it doesn't become too unmanageable to have just one file).
the guide is automatically generated from the files in guide-src/
by guide-src/make.py
(you can also just run make
to generate it), which is a simple script whose main purpose is adding
a sidebar to all of the guide pages. any PNG files are automatically copied from guide-src/
to guide/
.
when you add or remove pages from the guide, you'll need to edit guide-src/outline.txt
.