The libprocessing website. It's a plain Astro site, styled with the Processing Foundation design tokens, and every page is a Markdown file.
npm install
npm run dev # http://localhost:4321
npm run build # static site in dist/| Path | What |
|---|---|
src/content/docs/ |
Every page. Each top-level folder is a section; its index.md is the landing page. |
src/content/examples/<category>/ |
One file per example in the gallery. |
templates/ |
Starting points for a new page or example. Copy one, then rename it. |
src/site.ts |
Site title, colour theme, external links, and the "Edit on GitHub" base URL. |
src/content.config.ts |
Frontmatter schemas. The build fails if a page doesn't match. |
src/lib/examples.ts |
Example categories and group order. |
src/styles/ |
PF tokens (variables.css and friends, copied from processing-foundation-website), plus layout.css and prose.css. |
src/lib/callouts.ts |
Turns :::note, :::tip, :::caution and :::todo blocks into callouts. |
The full guide for writers is on the site at /contributing/writing-docs/, from src/content/docs/contributing/writing-docs.md.
See CONTRIBUTING.md. Everyone taking part is expected to follow the Code of Conduct.
The content and the code of this website are separately licensed.
- The content, the documentation text in
src/content/, is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC-BY-NC-SA-4.0). - The code that structures the website is licensed under the GNU General Public License version 2 (GPL-2.0).
For licensing information about libprocessing itself, see https://github.com/processing/libprocessing/blob/main/LICENSE.md
We don't have any actions set up for this right this second. For now, just run:
npm run build
npx wrangler deploy