API Cheats Reference

{% image "path/to/image.jpg", "Alt text", "css-class" %}
{% image "/assets/images/hero.jpg", "Hero image", "hero-image" %}

<img src="/assets/images/path/to/image.jpg" alt="Alt text" class="css-class" loading="lazy">

{% svg "path/to/icon.svg", "css-class" %}
{% svg "/assets/images/logo.svg", "site-logo" %}

<svg class="css-class" role="img" aria-label="SVG icon">
  <!-- SVG content -->
</svg>

{% code "javascript" %}
function hello() {
  console.log("Hello World!");
}
{% endcode %}

{{ title | seoTitle: site.name }}
{{ "My Post" | seoTitle: "My Site" }}

{{ page.url | canonical: site.url }}
{{ "/blog/post" | canonical: "https://example.com" }}

{{ "/assets/image.jpg" | absoluteUrl: site.url }}
{{ content | absoluteUrl: site.url }}

{{ date | formatDate: "YYYY-MM-DD" }}
{{ date | formatDate: "MMMM Do, YYYY" }}
{{ date | formatDate: "relative" }}

{{ content | excerpt: 160 }}
{{ content | excerpt: 300 }}

{{ content | stripHtml }}
{{ "<p>Hello <strong>World</strong></p>" | stripHtml }}

{{ "My Awesome Post!" | slugify }}
{{ "Hello World" | slugify }}

{{ site.name }}              // "Quesby - Boilerplate"
{{ site.url }}               // "https://example.com"
{{ site.description }}       // "Site description"
{{ site.author }}            // "Author Name"
{{ site.logo }}              // "/assets/images/logo.svg"
{{ site.favicon }}           // "/assets/images/favicon.webp"
{{ site.theme }}             // "quesby-core"
{{ site.defaultVisualTheme }} // "dark"
{{ site.socialImage }}       // "/assets/images/og-image.jpg"
{{ site.twitter }}           // "@username"
{{ site.language }}          // "en-US"

{{ collections.posts }}           // All blog posts
{{ collections.documentation }}   // All documentation pages
{{ collections.pages }}           // All regular pages
{{ collections.projects }}         // All project pages
{{ collections.news }}            // All news items

{{ page.url }}              // Current page URL
{{ page.date }}             // Page creation date
{{ page.inputPath }}        // Source file path
{{ page.outputPath }}       // Output file path
{{ page.fileSlug }}         // URL slug
{{ page.filePathStem }}     // File path without extension

---
title: "Page Title"
description: "Page description"
date: 2024-01-15
author: "Author Name"
tags: ["tag1", "tag2"]
draft: false
---

---
seoTitle: "Custom SEO Title"
seoDescription: "Custom SEO description"
seoImage: "/custom-image.jpg"
seoKeywords: "keyword1, keyword2"
seoCanonical: "https://example.com/custom-url"
seoNoIndex: false
seoNoFollow: false
---

---
image: "/assets/images/featured.jpg"
postType: "article"  # or "website"
noindex: false
class: "custom-page-class"
---

{{ postClass }}             // CSS class for post pages
{{ postType }}              // Open Graph type
{{ class }}                 // Page-specific CSS class

{{ theme }}                 // Current theme name
{{ site.theme }}            // Same as above

{{ env.QUESBY_CONTENT_PATH }}
{{ env.NODE_ENV }}

{% for post in collections.posts %}
  <article>
    <h2><a href="{{ post.url }}">{{ post.data.title }}</a></h2>
    <p>{{ post.data.description }}</p>
    <time>{{ post.date | formatDate: "MMMM Do, YYYY" }}</time>
  </article>
{% endfor %}

<nav>
  <ul>
    <li><a href="/">Home</a></li>
    <li><a href="/blog/">Blog</a></li>
    <li><a href="/documentation/">Docs</a></li>
  </ul>
</nav>

<meta property="og:title" content="{{ seoTitle or title }}">
<meta property="og:description" content="{{ description }}">
<meta property="og:image" content="{{ image | absoluteUrl: site.url }}">
<meta property="og:url" content="{{ page.url | canonical: site.url }}">

{% if draft %}
  <div class="draft-notice">This is a draft</div>
{% endif %}

{% if tags %}
  <div class="tags">
    {% for tag in tags %}
      <span class="tag">{{ tag }}</span>
    {% endfor %}
  </div>
{% endif %}