Publishing

The repository is aivrar/psychedelia-studio, with the display name Psychedelia Studio. The live studio is served by GitHub Pages from the main branch. The local wiki export helper prepares files; it does not commit or publish them automatically.

Repository contents

The app needs four runtime entries: index.html, style.css, src/, and lib/. The HTML is an entry point that loads separate scripts and styles; it is not a self-contained single-file build. Keep all four together when running or hosting it.

The repository additionally includes the README, contributor/third-party notes, maintained wiki, and relevant audit/documentation tools. A static deployment needs only the four runtime entries; the wiki screenshots are documentation assets, not required by the app.

The supplied .gitignore uses a root allowlist. Experiments, planning files, backups, terminal scratch files, historical internal notes, installed dependencies, generated audit logs/media, and wiki staging output stay out of normal Git additions. It does not delete those files. Curated wiki screenshots, metadata, and the vendored Tone.js license are included.

Before the first public commit, review the staged file list and diff. The project-wide license remains to be chosen by the owner. The supplied Tone.js MIT notice covers that dependency only. Existing shader provenance and imported media terms should be retained; this documentation pass is not a complete license/provenance audit.

Validate the prepared files

From the project root:

node tools/check-wiki.mjs
node --test tools/beat-reactor.test.mjs tools/core-regression.test.mjs tools/shuffle.test.mjs

Review Git identity and authentication in your normal Git client before publishing updates; no login identifier or credential belongs in the README or wiki. The public project attribution is aivrar.

The repository README uses relative documentation and image links and also links to the live app and published Wiki. .nojekyll keeps the Pages deployment a static app without processing its source as a Jekyll site.

Presentation and discovery

The repository description and topics emphasize music visualizers, animation creation, fractal art, VJ loops, motion graphics, and animated backgrounds. Update those when the product's capabilities change; avoid unrelated topics.

The live app provides search-description and Open Graph/Twitter sharing metadata. .github/social-preview.jpg is a 1280×640 branded card built from an actual studio render. Recreate it with node tools/build-wiki-assets.mjs social.

For GitHub's own repository link preview, open repository Settings → General → Social preview → Edit → Upload an image and choose that JPEG. The image must be set through GitHub's settings separately from the app's metadata. See GitHub's social preview instructions.

Prepare the GitHub Wiki

GitHub stores a wiki as a separate Git repository. Create an initial wiki page on GitHub before cloning its .wiki.git repository. Only changes pushed to that wiki's default branch appear as the live wiki. See GitHub's wiki editing instructions.

Create a publishable local export:

node tools/prepare-wiki.mjs

This writes .wiki-export/ with pages, _Sidebar.md, _Footer.md, images, and capture metadata. It removes each page's leading H1 because GitHub already displays the page title, then rewrites repository-relative page links to full wiki URLs and image links to that wiki's raw image URLs. The original docs/wiki/ keeps its titles for browsing inside the main repository. GitHub documents Markdown wiki links and image embedding in Editing wiki content.

After the main repository and initial wiki page exist, clone the wiki to a sibling directory and export into it:

git clone https://github.com/aivrar/psychedelia-studio.wiki.git ../psychedelia-studio.wiki
node tools/prepare-wiki.mjs ../psychedelia-studio.wiki
git -C ../psychedelia-studio.wiki status --short
git -C ../psychedelia-studio.wiki diff

The export overwrites same-named generated pages/images in its destination but does not delete unrelated pages. Review the diff before committing. Then commit and push the wiki through the usual Git workflow when publication is intended. The script performs no network, commit, or push action.

For a different repository, supply its name explicitly:

node tools/prepare-wiki.mjs .wiki-export owner/repository

Verify after publication

Open Wiki Home, Quick Start, the catalog, one category page, and the palette/gallery pages. Confirm sidebar navigation, intra-page links, image loading, and download-sized images. Check the README from the repository homepage as well. Local validation checks targets and metadata; it does not substitute for a final check of the hosted GitHub renderer.

Maintain one source

Edit guides under docs/wiki/, refresh generated references when definitions change, and regenerate the wiki export. For images, run the capture helpers and inspect the results before publishing. Use the Development guide for commands and Gallery for shot recipes.