How joaquinlarroca/pizzajs works
Project type and purpose
• It also ships with a template “starter” project, a suite of HTML/JS example tests, and a full documentation site generated via MkDocs (and optionally Jekyll via GitHub Pages).
File structure
• source/
• Core ES-modules under source/modules/:
– global.js (shared state, helpers)
– functions.js (drawing, loading, setup)
– classes.js (actors, buttons, hitboxes, sliders, timeouts, etc.)
– listener.js (keyboard/mouse/resize listeners)
• -ons under source/Addons/ (particle, miniMonitor, localstorage, etc.)
• template/project/
• A ready-to-rename starter project that brings in PizzaJS modules.
• mkdocs/ + docs/
• Markdown docs in mkdocs/docs/ → built by MkDocs into HTML under docs/.
• Custom overrides, scripts, assets for search & rendering.
• .github/
• CI workflow (jekyll-docker.yml) to build & deploy the docs as a GitHub Pages site.
• tests/
• A collection of self-contained HTML/JS examples verifying different features.
README insights
• Emphasizes usage: import modules or all at once, call initLoaderCheck(), then use setup(), start().
• Points to the template project for bootstrapping.
• Documentation site is live via GitHub Pages.
• CI badge shows automated docs deployment.
Main components & relationships
a. Core Library Modules (source/modules + source/Addons)
b. Client Project (template/project renamed by user)
c. Example/Test Suite (tests folder)
d. Documentation Pipeline
• MkDocs transforms Markdown → static HTML
• Placed under docs/
• GitHub Actions (jekyll-docker.yml) picks up docs/ and pushes to Pages
e. CI/CD (GitHub Actions)
f. External Services (GitHub Pages for hosting documentation)
Architectural patterns & design principles
• Modularity: ES-module boundaries separate responsibilities (global vs functions vs classes vs listeners).
• Extensibility: Add-ons folder can inject new behaviors.
• Separation of concerns: Template project is decoupled from core source via import statements.
• Static site generation: MkDocs pipeline plus optional Jekyll for theming.
Relevant technologies/frameworks/libraries
• JavaScript ES-Modules
• CSS for styling
• MkDocs (Python-based static site generator)
• GitHub Actions for CI/CD
• GitHub Pages for hosting docs
• ES-Modules (global.js, functions.js, classes.js, listener.js)
• -ons (DefaultScreenshot, miniMonitor, etc.)
5. Technologies alongside each component.