default
HTML templates
Plain HTML with template tags, rendered by birkly-client.js. No build step.
Keep the HTML you already have. Birkly fills it with content through one script tag, or hands you JSON for whatever stack you prefer.
{from 'birkly' get 'integration'}
Write normal HTML and put template tags where content goes. birkly-client.js fetches published entries and fills them in. It works on the same host as Birkly or on any other domain.
In the docs: Website integration · Template cheat sheet
<!-- any page on any site -->
<script src="https://cms.example.com/birkly-client.js"></script>
<ul class="posts">
{for each entry in 'blog' ordered by newest limit 3}
<li>
<a href="post.html?collection=blog&slug={slug}">{title}</a>
<time>{created_at format "F j, Y"}</time>
</li>
{endfor}
</ul>
{for each entry in 'stacks'}
Pick by one question: who renders the page? All four read the same published content.
default
Plain HTML with template tags, rendered by birkly-client.js. No build step.
web components
Drop in a <birkly-region> for a header, footer or list, and enhance it with your own JavaScript.
SPA
Fetch JSON from the Public API or Birkly.fetch and render with your own components.
SSR / build time
Render on the server or at build time for SEO, no-JavaScript fallbacks and static hosting.
In the docs: Choose your stack · Public API
{from 'templates' get 'language'}
Single braces, plain sentences, nothing to compile. Here is most of it.
loops
Filter, sort and limit any collection.
{for each entry in 'events'
ordered by newest limit 5}
conditionals
Fallbacks for empty fields and per-language copy.
{if entry has 'image'}…{else}…{endif}
single entries
Load a header, a footer or any one-off page block.
{from 'site_elements' get entry 'footer'}
detail pages
One template serves every entry; the URL says which.
post.html?collection=blog&slug={slug}
media
Ready helpers for images, galleries, maps and videos.
{media_img('hero', 'Alt text')}
forms
Visitor submissions become entries in a collection.
{entry for 'contact'}…{endentry}
{from 'birkly' get 'delivery' with 'control'}
Birkly runs wherever PHP runs and decides itself which hostname serves the admin and which serves the site.
rendering
Files in the project folder render on the server. Any other site connects through one script tag and renders in the browser. Same templates either way.
routing
A single blog-post.html serves the whole collection. Add an entry and its page exists. No generation step, no deploy.
hosting
Shared hosting, a VPS, a container. No Node process to keep alive, no queue to supervise, no service you cannot restart yourself.
insights
Privacy-friendly delivery metrics in the same admin, so you are not bolting a dashboard onto a CMS that already knows the answer.
git
Design and templates stay versioned with your remote, so a rollback is a revert rather than a restore from backup.
Need more speed? Optional hydration, snapshots and pre-rendering exist for high-traffic or SEO-critical pages.
In the docs: Self-host install · Git sync · Production delivery