RubyGems - abqari - Versions diffs - 1.1.0 - Mend

abqari 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1509) hide show

data/lib/abqari/templates/site_skeleton/config/site.yml.tt ADDED Viewed

@@ -0,0 +1,266 @@
+# Abqari site configuration.
+#
+# Top-level keys are shared across environments. Per-environment
+# overrides go under `environments:` and deep-merge over the shared
+# keys based on $ABQARI_ENV (default: development).
+#
+# This starter ships with sensible defaults — edit `title`, `description`,
+# `author`, and `environments.production.url` immediately; the rest can
+# wait until you have a feel for what you want.
+# Site identity ──────────────────────────────────────────────────────────
+title: <%= yaml.call(title) %>
+description: <%= yaml.call(description) %>
+author: <%= yaml.call(author) %>
+# Locale ─────────────────────────────────────────────────────────────────
+# ISO 639-1 code. Sets <html lang>, RSS <language>, and Preferred-
+# Languages in security.txt. Single-locale only.
+locale: <%= yaml.call(locale) %>
+# SEO + social sharing ───────────────────────────────────────────────────
+# Solid SEO ships as standard: page titles, meta descriptions,
+# canonical URLs, Open Graph + Twitter cards, JSON-LD structured data,
+# sitemap.xml, robots.txt, and RSS feeds all render automatically once
+# `environments.production.url` (bottom of this file) is set. The
+# knobs below are optional refinements — uncomment to use.
+# Default share image — used as og:image / twitter:image for pages
+# without their own image (home page, tag pages). A site-relative
+# path (put the file in app/assets/images/) or a full URL.
+# share_image: /assets/images/share-default.png
+# Auto-generated share cards — when enabled, every page without a
+# hero image gets a themed SVG card at <page-url>og.svg, so links
+# shared to social networks always show something on-brand.
+# og_images:
+#   auto: true
+# Twitter / X identity on share cards. Both optional; per-post
+# `twitter_creator:` frontmatter overrides the site default.
+# twitter:
+#   site:    "@yourhandle"
+#   creator: "@yourhandle"
+# og:locale override, in <lang>_<region> format (Facebook prefers
+# it). Falls back to `locale` when unset.
+# og_locale: en_US
+# AI training crawlers (GPTBot, ClaudeBot, CCBot, Google-Extended, …)
+# are blocked in robots.txt BY DEFAULT. Regular search engines
+# (Googlebot, Bingbot) are unaffected — this does not touch your
+# search ranking. Set false if you want AI training to use your
+# content.
+# block_ai_scraping: true
+# Theme ──────────────────────────────────────────────────────────────────
+# Visual styling. Each theme is one CSS file in themes/<name>/ inside
+# the engine gem. Switch freely — none of the theme files are in this
+# repo (they live in the gem). Built-ins: minimal / magazine / notebook /
+# bootstrap / sand / custom / none. To customize one, copy it into this
+# repo with `abqari theme eject <name>`; your copy shadows the gem's.
+# Full token reference:
+# https://github.com/grantrayner/abqari/blob/main/docs/theming.md
+theme: <%= yaml.call(theme) %>
+# Fonts ──────────────────────────────────────────────────────────────────
+<%= fonts_block %>
+# Bundle assets ──────────────────────────────────────────────────────────
+# Files colocated with a post's index.md are published alongside it when
+# their extension is a known media type — images, video, audio, subtitles,
+# PDF/EPUB/ZIP. Anything else stays behind and is reported at build time,
+# so working files (.psd, .sketch, draft notes) don't ship by accident.
+#
+# Markdown is content, not an asset: only index.md renders, and a second
+# .md in the folder is skipped entirely. To keep a file local with no
+# build warning, prefix it with a dot (.notes.md).
+#
+# Add extensions here if your site publishes something else:
+# bundle_assets:
+#   extensions: [.gpx, .stl]
+# Collections ────────────────────────────────────────────────────────────
+# Four collections ship as built-in defaults. Flip enabled to false on
+# any your site doesn't use. Per-collection toggles for index / show /
+# archive / feeds / next / related / toc are scaffolded with sensible
+# defaults. Full surface:
+# https://github.com/grantrayner/abqari/blob/main/docs/publications.md
+collections:
+  posts:
+    enabled: true
+    index:
+      cover: photo                 # photo / photo_or_svg / svg / none
+      show_date: true
+      show_description: true
+      description_truncate: 160
+      show_reading_time: true
+      show_tags: false
+      latest_count: 8
+    show:
+      cover: photo                 # hero at the top of the post body
+      toc:
+        enabled: true
+        min_headings: 3
+        levels: [2, 3]             # h2 + h3 in the TOC
+      next:
+        enabled: true              # "Up next" card below the post body
+      related:
+        enabled: true
+        limit: 3
+        match_by: tags
+        show_image: true
+    archive:
+      enabled: false               # turn on + create content/posts-archive.md
+                                   # to enable the long-tail archive page
+    feeds:
+      enabled: true                # RSS + JSON Feed at /feed.xml + /feed.json
+                                   # (root paths — subscribers expect them there)
+  # Photo galleries. Scaffold enabled with `abqari new ... --with photos`,
+  # or flip `enabled:` later — create `content/photos/index.md` too (the
+  # collection index page is a real content file, not auto-generated).
+  photos:
+    enabled: <%= with.include?('photos') %>
+  # Books / atlases / anything with a cover and a price. Scaffold with
+  # `--with publications`, or flip later + create
+  # `content/publications/index.md`.
+  publications:
+    enabled: <%= with.include?('publications') %>
+  # Training offerings / courses. Scaffold with `--with workshops`, or
+  # flip later + create `content/workshops/index.md`.
+  workshops:
+    enabled: <%= with.include?('workshops') %>
+# Home modules ──────────────────────────────────────────────────────────
+# Optional cards rendered below content/index.md's markdown body.
+# Off by default — your home page renders just the markdown until you
+# flip these on.
+home:
+  latest_post:          false
+  random_post:          false
+  featured_publication: false
+  latest_publication:   false
+  next_workshop:        false
+  latest_photo:         false
+  random_photo:         false
+  photo_gallery:        false      # 'latest' / 'random' / false
+  contact:              false      # needs `contact.email` below
+# Navigation ────────────────────────────────────────────────────────────
+# Nav links come from per-page frontmatter — drop a `nav:` block on a
+# page (see `content/index.md`, `content/about.md`) and the page joins
+# the top nav at `nav.order`. To override globally, create `data/nav.yml`
+# with a `links:` list; the engine prefers that over the frontmatter
+# cascade when present. The `nav:` key here is reserved for site-wide
+# nav SETTINGS (e.g. a `brand:` block), NOT a list of links.
+#
+# nav:
+#   brand: My Site                # text shown on the left of the nav
+#                                 # (defaults to site title)
+# Footer ────────────────────────────────────────────────────────────────
+# `{year}` is replaced with the current year at build time, so the
+# signature never goes stale. Set `signature: false` to omit the line.
+footer:
+  signature: "Built with Abqari · {year}"
+# Social links — one footer icon per entry. Each key must match an SVG
+# in app/icons/<key>.svg (shipped: github, rss, mail, x, mastodon,
+# bluesky, linkedin). Values are used verbatim as the link target, so
+# give full URLs, not bare handles. Uncomment what applies.
+# social:
+#   github:   https://github.com/your-handle
+#   mastodon: https://mastodon.social/@your-handle
+#   bluesky:  https://bsky.app/profile/your-handle.bsky.social
+#   x:        https://x.com/your-handle
+#   linkedin: https://linkedin.com/in/your-handle
+#   rss:      /feed.xml
+#   mail:     mailto:hello@example.com
+# Contact button ────────────────────────────────────────────────────────
+# Spam-resistant mailto button. Off by default; populate `email` to opt in.
+# contact:
+#   email: hello@example.com
+# IndieWeb / federation ────────────────────────────────────────────────
+# Off by default. Once enabled, the build:
+#   * Adds <link rel="webmention"> so other sites can notify yours.
+#   * Renders received mentions ("Replies & mentions") below each post,
+#     pulled from webmention.io at build time.
+#   * Optionally advertises the site as a Bridgy Fed ActivityPub actor
+#     so Mastodon users can follow `@<domain>` directly.
+#   * Optionally POSTs outbound webmentions to sites your posts link to.
+#
+# Setup (one-time):
+#   1. Sign in at https://webmention.io with your domain (uses rel=me
+#      verification — your social_links above must carry at least one
+#      profile that links back to your domain).
+#   2. Copy the API token from your webmention.io account page.
+#   3. For Bridgy Fed: visit https://fed.brid.gy/, follow its setup
+#      (same rel=me pattern). Then flip `bridgy_fed: true` below.
+#
+# indieweb:
+#   enabled: true
+#   domain: example.com               # bare host, no scheme
+#   webmention_io_token: "..."        # from webmention.io account page
+#   bridgy_fed: false                 # true once Bridgy Fed setup complete
+#   send_webmentions: false           # POST to sites your posts link to
+#   send_window_days: 30              # only send for posts published this
+#                                     #   recently — historical posts have
+#                                     #   already been notified in earlier
+#                                     #   builds; replaying is wasteful
+# Syndication (POSSE) ─────────────────────────────────────────────────
+# "Publish on your Own Site, Syndicate Elsewhere" — on each build, the
+# engine POSTs a short summary + canonical URL of each new post to
+# the configured networks. The originating post on your site stays the
+# source of truth; readers on Mastodon/Bluesky discover new work in
+# their feed; replies on those networks come back as webmentions (via
+# Bridgy Fed) and render below the post.
+#
+# Idempotent: every successful crosspost is logged to
+# `vendor/syndication/sent.yml` so re-builds never double-post.
+#
+# Per-post override: set `syndicate: false` in a post's frontmatter to
+# skip syndication for that post; set `syndication_text: "..."` to
+# supply a custom snippet.
+#
+# Setup steps:
+#   * Mastodon — in your instance UI: Preferences → Development →
+#     New Application, scope `write:statuses`. Copy the access token.
+#   * Bluesky  — in the app: Settings → App Passwords → Add. Use the
+#     app password (NOT your account password) below.
+#
+# syndication:
+#   enabled: true
+#   window_days: 14                   # only syndicate posts from the last
+#                                     #   N days — older posts predate
+#                                     #   syndication setup; replaying
+#                                     #   would look like spam
+#   mastodon:
+#     enabled: true
+#     instance: https://mastodon.social
+#     access_token: "..."
+#     visibility: public              # public | unlisted | private
+#   bluesky:
+#     enabled: true
+#     handle: yourname.bsky.social
+#     app_password: "..."             # app password, NOT account password
+# Environment overrides ────────────────────────────────────────────────
+# These deep-merge over the shared keys based on $ABQARI_ENV. Set your
+# production URL here so canonical links, sitemap, and OG cards all
+# resolve correctly when deployed.
+environments:
+  development:
+    url: http://localhost:4000
+  production:
+    url: https://www.example.com   # ← edit me before deploying

data/lib/abqari/templates/site_skeleton/content/404.md ADDED Viewed

@@ -0,0 +1,17 @@
+---
+title: Page not found
+published: true
+description: The page you're looking for doesn't exist.
+permalink: /404.html
+sitemap: false
+robots: noindex
+nav: ~
+---
+# 404
+The page you're looking for doesn't exist — it may have been moved,
+renamed, or never existed in the first place.
+- [Go to the home page](/)
+- [Browse the posts](/posts/)

data/lib/abqari/templates/site_skeleton/content/about.blank.md.tt ADDED Viewed

@@ -0,0 +1,12 @@
+---
+title: About
+published: true
+description: <%= yaml.call("About #{title}.") %>
+nav:
+  order: 99
+  label: About
+---
+# About
+A short bio.

data/lib/abqari/templates/site_skeleton/content/about.md.tt ADDED Viewed

@@ -0,0 +1,18 @@
+---
+title: About
+published: true
+description: <%= yaml.call("About #{title}.") %>
+nav:
+  order: 99
+  label: About
+---
+# About
+A short bio, your story, what you write about — whatever makes sense
+for your site. This page sits at `/about/`. Edit `content/about.md`
+to change the content.
+The `nav:` block in the frontmatter pins this page at the end of the
+top nav (order: 99 — last). Drop the block, or set `nav: ~`, to hide
+it from the nav entirely.

data/lib/abqari/templates/site_skeleton/content/index.blank.md.tt ADDED Viewed

@@ -0,0 +1,11 @@
+---
+title: <%= yaml.call(title) %>
+published: true
+description: <%= yaml.call(description) %>
+layout: home
+nav:
+  order: 1
+  label: Home
+---
+Welcome.

data/lib/abqari/templates/site_skeleton/content/index.md.tt ADDED Viewed

@@ -0,0 +1,34 @@
+---
+title: <%= yaml.call(title) %>
+published: true
+description: <%= yaml.call(description) %>
+layout: home
+nav:
+  order: 1
+  label: Home
+---
+Welcome to <%= title %>.
+This is your home page. Edit `content/index.md` to change what shows
+up here. Markdown, ERB partials (with the right config), the works.
+Below the markdown body, Abqari can render optional home modules —
+latest post, photo gallery, featured publication, contact button, and
+more. Toggle them on under `home:` in `config/site.yml`.
+## Where to next
+- [Read the latest posts](/posts/)
+- [About](/about/)
+## Customising
+| Where | What |
+|---|---|
+| `config/site.yml` | Site identity, theme, collections, environment URLs |
+| `content/index.md` | This page |
+| `app/assets/css/site.css` | Your custom CSS, loaded after the theme |
+When you're ready: edit `config/site.yml`, set the production `url:`,
+flip on the collections and home modules you need.

data/lib/abqari/templates/site_skeleton/content/photos/index.md.tt ADDED Viewed

@@ -0,0 +1,12 @@
+---
+title: Photos
+published: true
+description: Photo galleries, newest first.
+nav:
+  order: 3
+  label: Photos
+---
+Photo galleries, newest first. Each photo is a bundle at
+`content/photos/<slug>/index.md` with the image alongside it —
+set `image:` in the frontmatter and the gallery index picks it up.

data/lib/abqari/templates/site_skeleton/content/posts/index.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+title: Posts
+published: true
+description: The latest posts on the site, newest first.
+nav:
+  order: 2
+  label: Posts
+---
+The latest posts, newest first. Use `bin/new post "Title"` to scaffold
+a new one — it goes in `content/posts/<YYYY-MM-DD>-<slug>/index.md`
+with the right frontmatter shape.

data/lib/abqari/templates/site_skeleton/content/posts/welcome/index.md.tt ADDED Viewed

@@ -0,0 +1,50 @@
+---
+title: <%= yaml.call("Welcome to #{title}") %>
+published: true
+date: <%= Time.now.strftime('%Y-%m-%d') %>
+description: A starter post. Edit or delete this once you're up and running.
+tags: [welcome]
+---
+This is your first post. Edit it, rename the directory to a real slug,
+or delete it entirely. Posts live in `content/posts/<slug>/index.md`
+with sibling asset files (images, etc.) next to them — Abqari's
+bundle convention lets you reference `hero.jpg` in this post body and
+the image pipeline rewrites it into a responsive `<picture>` block
+on build.
+## How to write posts
+```bash
+bin/new post "My next post"   # scaffolds content/posts/<date>-my-next-post/index.md
+```
+Drop colocated images in the bundle directory and reference them by
+relative path:
+```markdown
+![A hero image](hero.jpg)
+```
+The image pipeline takes care of AVIF + WebP variants, multiple
+widths, and the correct `<source>` order. The `<img>` keeps its
+`width` and `height` attributes so there's no layout shift.
+## Posts you'll see surfaced
+On a single post page, the engine renders three optional tail
+sections (toggle each under `posts.show:` in `config/site.yml`):
+- **Table of contents** — built from h2/h3 headings when there are
+  three or more
+- **Up next** — single card linking to the next chronological post
+- **Related** — grid of posts sharing tags (or whatever `match_by:`
+  field you point it at)
+Each is silent when there's nothing meaningful to show.
+## Configuration
+Toggle the collections and modules you need in `config/site.yml`.
+The defaults give you `posts` only; flip on `photos`, `publications`,
+or `workshops` when you have content for them.

data/lib/abqari/templates/site_skeleton/content/publications/index.md.tt ADDED Viewed

@@ -0,0 +1,13 @@
+---
+title: Publications
+published: true
+description: Books, essays, and other publications.
+nav:
+  order: 4
+  label: Publications
+---
+Books, essays, atlases — anything with a cover. Each publication is a
+bundle at `content/publications/<slug>/index.md` with `cover:` art
+alongside it. Configure `folio:` in `config/site.yml` to auto-fill
+this collection from a Folio storefront instead.

data/lib/abqari/templates/site_skeleton/content/workshops/index.md.tt ADDED Viewed

@@ -0,0 +1,13 @@
+---
+title: Workshops
+published: true
+description: Workshops, courses, and training offerings.
+nav:
+  order: 5
+  label: Workshops
+---
+Workshops and training offerings. Each one is a bundle at
+`content/workshops/<slug>/index.md` — structured metadata
+(`date_from`, `date_to`, `duration`, `location`, `format`, `price`,
+`registration_url`) renders above the body markdown.

data/lib/abqari/templates/site_skeleton/public/robots.txt ADDED Viewed

@@ -0,0 +1,6 @@
+# Default robots policy. The engine emits a per-environment override at
+# /_site/robots.txt during build, so this file is the fallback / static
+# passthrough version (not normally served). Edit only if you want to
+# bypass the dynamic generator.
+User-agent: *
+Allow: /

data/lib/abqari/templates/site_skeleton/themes/.gitkeep ADDED Viewed

File without changes

data/lib/abqari/templates/site_skeleton/vendor/folio/.gitkeep ADDED Viewed

File without changes

data/lib/abqari/templates/site_skeleton/vendor/fonts/.gitkeep ADDED Viewed

File without changes

data/lib/abqari/theme_bootstrap.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'digest'
+require 'base64'
+module Abqari
+  # Tiny inline `<script>` injected into <head> on every page. It reads the
+  # user's stored theme preference from localStorage and sets a `data-theme`
+  # attribute on <html> *before* the document renders — so dark/light mode
+  # snaps in immediately, no flash of unstyled content.
+  #
+  # Kept as a stable single-line string so its SHA256 hash is stable across
+  # builds. The hash is added to the CSP's script-src directive so the strict
+  # `'self'`-only policy still allows this one inline script.
+  module ThemeBootstrap
+    SCRIPT = "(function(){var t=localStorage.getItem('theme');if(t)document.documentElement.setAttribute('data-theme',t)})()"
+    SHA256 = "sha256-#{Base64.strict_encode64(Digest::SHA256.digest(SCRIPT))}"
+  end
+end

data/lib/abqari/theme_fonts.rb ADDED Viewed

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+module Abqari
+  # The self-hosted webfonts each shipped theme's font stacks ask for.
+  # A theme is a token file — its `--font-*` stacks can name any face —
+  # but the faces only render if the site actually downloads them
+  # (`fonts:` in config/site.yml + `bin/fetch-fonts`). Before this map
+  # existed, magazine and sand silently fell back to system serifs on
+  # every site that didn't hand-maintain the list, and their typographic
+  # identity never materialised.
+  #
+  # Consumed by `abqari new --theme <name>` (scaffolds the matching
+  # `fonts:` block) and `abqari theme eject` (prints the block as a
+  # hint). Themes not listed use system fonts and need nothing.
+  module ThemeFonts
+    FONTS = {
+      # Display headings; body is Charter/Palatino/Georgia (system).
+      'magazine' => [
+        { 'family' => 'Playfair Display', 'weights' => [700], 'style' => 'normal' }
+      ].freeze,
+      # Inter body + JetBrains Mono for headings/meta/code.
+      'notebook' => [
+        { 'family' => 'Inter',          'weights' => [400, 600], 'style' => 'normal' },
+        { 'family' => 'JetBrains Mono', 'weights' => [400, 600], 'style' => 'normal' }
+      ].freeze,
+      # Merriweather body (regular + italic — serif prose needs a true
+      # italic) + Merriweather Sans for headings and UI.
+      'sand' => [
+        { 'family' => 'Merriweather',      'weights' => [400, 700], 'style' => 'normal' },
+        { 'family' => 'Merriweather',      'weights' => [400],      'style' => 'italic' },
+        { 'family' => 'Merriweather Sans', 'weights' => [400, 600], 'style' => 'normal' }
+      ].freeze
+    }.freeze
+    def self.for(theme)
+      FONTS.fetch(theme.to_s, [])
+    end
+    # The `fonts:` entries as site.yml-ready YAML lines (no leading
+    # `fonts:` key — callers decide how to frame the block).
+    def self.yaml_entries(theme, indent: '')
+      self.for(theme).map do |font|
+        <<~YAML.gsub(/^/, indent).rstrip
+          - family: #{font['family']}
+            weights: [#{font['weights'].join(', ')}]
+            style: #{font['style']}
+        YAML
+      end.join("\n")
+    end
+  end
+end

data/lib/abqari/version.rb ADDED Viewed

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# The version constant lives alone, in a file with NO requires, because
+# `abqari.gemspec` loads it to read `Abqari::VERSION`.
+#
+# The gemspec used to `require_relative 'lib/abqari'` instead, which
+# pulls in the whole engine — and with it erubi, commonmarker, rouge and
+# webrick. That works locally (those gems are already installed) but
+# breaks any git or path source: Bundler evaluates the gemspec BEFORE
+# installing dependencies, so the requires blow up with
+# "cannot load such file -- erubi". Published gems are immune (their
+# spec is pre-serialized into the .gem), which is exactly why the bug
+# only surfaced on a clean CI/deploy builder.
+#
+# Keep this file dependency-free.
+module Abqari
+  VERSION = '1.1.0'
+end