Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.3 KB

README.md

File metadata and controls

64 lines (45 loc) · 2.3 KB

Downspout Pages source

This directory is the source for the GitHub Pages site.

Editing plugin text

Each plugin page is a Markdown file under _products/.

The short card text comes from the summary field in front matter. The longer body text starts below the front matter and can be expanded manually without touching the layouts.

When adding or changing a plugin page, check:

  • the product file has title, order, bundle, kind, category (generative, midi, instrument, processor or launchpad; now only a badge/search term), group, role, screenshot, and summary;
  • group is one of the ids in _data/groups.yml (generators, rhythm, drums, midi-tools, synths, sources, tone, space, spectral, dynamics). The index page sections, the A-Z list and the plugin-page kicker are all built from it, so a plugin without a valid group will not appear on the index. To add or rename a group, edit _data/groups.yml only;
  • the referenced screenshot exists under assets/plugins/;
  • scripts/capture-plugin-screenshots.sh --list includes the plugin;
  • the plugin order keeps a readable sequence within its index-page section (order sorts cards inside each category, not across the whole page).

Plugin reference

plugins-summary.md is a hand-maintained, per-plugin capability reference for automated agents, published at /plugins-summary/ and linked from the site nav, the cover page and the root README.md. It is not generated: when a plugin's ports, MIDI roles, CC map or key parameters change, update its paragraph and the quick-reference table in the same change.

Screenshots

Screenshots live under assets/plugins/ and are generated by:

scripts/capture-plugin-screenshots.sh

Run that script from the repository root after UI changes, then review the PNGs before publishing.

Layout

The shared page structure is in _layouts/, and the shared CSS is in assets/site.css.

The GitHub Actions workflow at .github/workflows/pages.yml builds this directory with Jekyll and deploys it to GitHub Pages.

Local preview

From the repository root:

jekyll serve --source docs/pages --destination /tmp/downspout-pages-site

Then open the URL printed by Jekyll. The configured project-page URL is http://127.0.0.1:4000/downspout/ when using the default local port.