The documentation site of Tiny Blocks, a set of small, focused, framework-agnostic PHP libraries, published at tiny-blocks.github.io.
The site holds no documentation of its own. When it is built, it reads the README.md and the composer.json of every
library from its repository, and its latest release and downloads from Packagist. Each README becomes the page of its
library, and the require sections of the composer.json files become the dependency graph the home draws as a wall
of blocks and every page lists as what the library stands on and what stands on it.
Add one line to CATALOG in src/content/catalog.ts, with the name of the repository and the area the home lists it
under. Everything else is read from the library itself.
To clone the repository using the command line, run:
git clone https://github.com/tiny-blocks/tiny-blocks.github.io.gitTo install project dependencies locally, run:
make configureTo start the development server with live reload, run:
make startTo stop the development server, run:
make stopTo build the site and its search index into dist/, run:
make buildTo serve the built site, search included, as it is published, run:
make previewTo draw the link-preview card into public/og-image.png, run:
make og-imageRun the unit tests:
make testsCheck the script every built page ships against its budget (run after make build):
make budgetsRun the linter, the formatter check and the Astro and TypeScript checks:
make reviewFix linter and formatter issues:
make fix-reviewRemove dependencies and generated artifacts:
make cleanYou can check other available commands by running
make help.
| Environment | URL |
|---|---|
Local |
http://localhost:4321/ |
Production |
https://tiny-blocks.github.io/ |
The Deploy site workflow builds the site and publishes it on GitHub Pages on every push to main, every day to pick up
new releases of the libraries, on demand from the Actions tab, and when a library sends a repository_dispatch of type
library-released.
Licensed under MIT.