PHPackages linkorb/blazon - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Templating & Views](/categories/templating) 4. / 5. linkorb/blazon ActiveApplication[Templating & Views](/categories/templating) linkorb/blazon ============== Blazon: publish fast and beautiful websites, campaign sites, documentation, guides etc from data (e.g. Xillion Resources) v1.3.0(4y ago)112[3 PRs](https://github.com/linkorb/blazon/pulls)MITPHPPHP >=7.2.0CI failing Since Aug 29Pushed 1y ago1 watchersCompare [ Source](https://github.com/linkorb/blazon)[ Packagist](https://packagist.org/packages/linkorb/blazon)[ Docs](http://www.github.com/linkorb/blazon)[ RSS](/packages/linkorb-blazon/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (5)Dependencies (12)Versions (9)Used By (0) blazon ====== [](#blazon) [![](docs/assets/blazon.png)](docs/assets/blazon.png) Blazon is a data-driven, plugin-powered, multi-target content publishing framework. Use-cases: ---------- [](#use-cases) - Documentation, guides, manuals - Contracts (with variables) - Legal documents - "Conditional text" content - Wiki content rendering - Marketing sites - Policies, Procedures, Forms - Knowledge graphs - Digital gardens - Code repository project documentation - Complex data graph visualization (i.e. organizational structures) Definitions: ------------ [](#definitions) - Publication: Collection of "documents" - Document: unique identifier (path), and a controller for rendering output - Plugin: allows to modify every phase of the loading and publishing process - Target: one of many outputs, produced by a Publisher (i.e. static html, pdf, etc). Features: --------- [](#features) - Load content from local or remote sources - Markdown, with frontmatter - Xillion Resources - Twig templating - Supports both static site generation and dynamic rendering Examples -------- [](#examples) - graphql + twig example site Installation ------------ [](#installation) ``` git clone git@github.com:linkorb/blazon.git cd blazon composer install # install php dependencies into blazon's vendor/ directory ./bin/blazon -v # get version and help output ``` Usage ----- [](#usage) Your Blazon project (i.e. your site, book, report, etc) should be stored in it's own directory, preferably a Git repository. From there, use the `blazon` cli tool to generate a static HTML site into the `build/` directory of your project: ### Publishing [](#publishing) ``` cd path/to/my/blazon-project path/to/blazon publish -vvv ``` This command: 1. Builds your Publication in-memory, using your custom `PublicationFactory`, or the default factory. 2. Loops over all registered `Document` instances 3. Renders the output of each `Document` using it's `handler` callback, and writes it to the Document's `path` into `build/` 4. Recursively copies any public assets (images, css, js, pdfs, etc) from `public/` into `build/` You can now serve the generated `build/` directory as a static (html) site on your favorite service: - A simple nginx container - Github pages - Netlify - ...etc ### Auto-Publishing with "watch-mode" [](#auto-publishing-with-watch-mode) Pass the `-w` flag to the `blazon publish` command to tell blazon to keep watching your project's source directory for changes. After any detected change, it will automatically (re)publish to `build/` ### Preview server [](#preview-server) Blazon includes a minimal preview server that you can use while authoring content and styling your publication. Simply point your favorite PHP-enabled webserver (i.e. apache with mod-php, nginx with php-fpm, etc) to blazon's `public/` directory. Make sure to setup `SOURCE_PATH=/path/to/your/blazon-project` in Blazon's `.env` file. Features: - Builds the publication on every HTTP request - In-memory, no writes to `build/` - Verbose error messages when setting `DEBUG=true` in your `.env` file. - Supports serving static assets from your publication's `public/` directory. It is not recommended to use the preview server in production. Use the `blazon publish` command instead for maximum security and performance. Inspiration ----------- [](#inspiration) - Gatsby - Hugo - Sage - Xillion - Schemata Contributing ------------ [](#contributing) We welcome contributions to make this repository even better. Whether it's fixing a bug, adding a feature, or improving documentation, your help is highly appreciated. To get started, fork this repository then clone your fork. Be sure to familiarize yourself with LinkORB's [Contribution Guidelines](/CONTRIBUTING.md) for our standards around commits, branches, and pull requests, as well as our [code of conduct](/CODE_OF_CONDUCT.md) before submitting any changes. If you are unable to implement changes you like yourself, don't hesitate to open a new issue report so that we or others may take care of it. Brought to you by the LinkORB Engineering team ---------------------------------------------- [](#brought-to-you-by-the-linkorb-engineering-team) [![](https://camo.githubusercontent.com/62fb66b034de7ea7fca9fd9776424b5348daa76ef8622caf92c2f7622003e5ef/687474703a2f2f7777772e6c696e6b6f72622e636f6d2f642f6d6574612f74696572312f696d616765732f6c696e6b6f7262656e67696e656572696e672d6c6f676f2e706e67)](https://camo.githubusercontent.com/62fb66b034de7ea7fca9fd9776424b5348daa76ef8622caf92c2f7622003e5ef/687474703a2f2f7777772e6c696e6b6f72622e636f6d2f642f6d6574612f74696572312f696d616765732f6c696e6b6f7262656e67696e656572696e672d6c6f676f2e706e67) Check out our other projects at [linkorb.com/engineering](http://www.linkorb.com/engineering). By the way, we're hiring! ### Health Score 27 — LowBetter than 49% of packages Maintenance31 Infrequent updates — may be unmaintained Popularity7 Limited adoption so far Community12 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~58 days Total 5 Last Release 1491d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/1db66b320db18b8036ea68211b7d8a39e7c6da97e6fd29f59a50380ebb69d0bb?d=identicon)[joostfaassen](/maintainers/joostfaassen) --- Top Contributors [![joostfaassen](https://avatars.githubusercontent.com/u/411113?v=4)](https://github.com/joostfaassen "joostfaassen (20 commits)")[![mhitza](https://avatars.githubusercontent.com/u/273079?v=4)](https://github.com/mhitza "mhitza (14 commits)")[![CesarScur](https://avatars.githubusercontent.com/u/366290?v=4)](https://github.com/CesarScur "CesarScur (6 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (3 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (3 commits)") --- Tags phptwiggraphqlgeneratormarkdowncontentstaticcmsdynamicgatsbyxillion ### Embed Badge ![Health badge](/badges/linkorb-blazon/health.svg) ``` [![Health](https://phpackages.com/badges/linkorb-blazon/health.svg)](https://phpackages.com/packages/linkorb-blazon) ``` ### Alternatives [craftcms/cms Craft CMS 3.6k3.6M2.6k](/packages/craftcms-cms)[tightenco/jigsaw Simple static sites with Laravel's Blade. 2.2k438.5k29](/packages/tightenco-jigsaw)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[picocms/pico Pico is a flat file CMS, this means there is no administration backend and database to deal with. You simply create .md files in the "content" folder and that becomes a page. 3.9k37.8k11](/packages/picocms-pico)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 595.2M386](/packages/shopware-core)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)