Skip to content
This repository was archived by the owner on Feb 10, 2025. It is now read-only.

Latest commit

 

History

History
39 lines (23 loc) · 1.2 KB

File metadata and controls

39 lines (23 loc) · 1.2 KB

THIS IS OUTDATED AND THE PICOTRACKER USER MANUAL IS NOW HOSTED IN THE MAIN PICOTRACKER REPO

Picotracker Manual

Development

While developing and writing content for the manual, you can have a preview of the site by running:

./preview.sh

If you need to download to run picosite you download a release from GitHub, eg. for a Linux binary:

mkdir bin; curl -L "https://github.com/maks/picosite/releases/download/0.2.0/picosite-linux" -o "bin/picosite"; chmod +x bin/picosite

When run in preview mode, picosite will serve the website on the url: http://localhost:8080 and will watch the site directory and its subdirectories for file changes and rebuild the output when it detects modifications to the files.

Building Outputs

Uses picosite and weasyprint to generate HTML and PDF outputs from the markdown source files.

HTML

To build the html output run:

./build.sh

PDF

TODO: instructions on building PDF with weasyprint.

Acknowledgements

Thanks to @squiggythings WaveTracker documentation website for initial CSS design and example of how to use nice, clean semantic HTML.