RubyGems - jackdaw - Versions diffs - 1.0.0 → 1.0.2 - Mend

jackdaw 1.0.0 → 1.0.2

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 (51) hide show

data/usejackdaw.com.site/site/src/getting-started.page.md ADDED Viewed

@@ -0,0 +1,180 @@
+# Getting Started
+Get your first site up and running in 5 minutes.
+## Create a New Site
+```bash
+jackdaw new my-blog
+cd my-blog.site
+```
+This creates a new directory with the following structure:
+```
+my-blog.site/
+├── site/
+│   ├── src/           # Your content (Markdown files)
+│   ├── templates/     # ERB templates
+│   └── assets/        # Static files (CSS, images, JS)
+└── public/            # Generated site (after build)
+```
+## Project Structure
+### Content (`site/src/`)
+Write your content in Markdown:
+```markdown
+# Hello World
+This is my first post!
+```
+File naming convention: `[date-]name.type.md`
+- `index.page.md` → `/index.html`
+- `about.page.md` → `/about.html`
+- `2026-01-06-hello.blog.md` → `/2026-01-06-hello.html`
+### Templates (`site/templates/`)
+ERB templates with access to content:
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= title %></title>
+</head>
+<body>
+  <h1><%= title %></h1>
+  <%= content %>
+</body>
+</html>
+```
+### Assets (`site/assets/`)
+Static files copied as-is to output:
+- CSS stylesheets
+- JavaScript files
+- Images
+- Fonts
+## Build Your Site
+```bash
+# Full build
+jackdaw build
+# Clean build (remove old files first)
+jackdaw build --clean
+# Verbose output
+jackdaw build --verbose
+```
+Output goes to `public/` directory.
+## Development Server
+Start the dev server with live reload:
+```bash
+jackdaw serve
+```
+Visit http://localhost:4000 and edit your files - changes appear instantly!
+Options:
+```bash
+jackdaw serve --port 3000        # Custom port
+jackdaw serve --no-livereload    # Disable live reload
+```
+## Create Content
+Use templates to quickly create new content:
+```bash
+# Create a blog post
+jackdaw create blog "My First Post"
+# → Creates: 2026-01-06-my-first-post.blog.md
+# Create a page
+jackdaw create page "About"
+# → Creates: about.page.md
+# Create in subdirectory
+jackdaw create page "docs/installation"
+# → Creates: docs/installation.page.md
+```
+List available templates:
+```bash
+jackdaw template list
+```
+## Your First Blog Post
+Let's create a blog:
+1. **Create blog template** (`site/templates/blog.html.erb`):
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= title %></title>
+  <meta name="description" content="<%= excerpt %>">
+</head>
+<body>
+  <article>
+    <h1><%= title %></h1>
+    <time><%= date.strftime('%B %d, %Y') %></time>
+    <%= content %>
+  </article>
+</body>
+</html>
+```
+2. **Create a post**:
+```bash
+jackdaw create blog "Building Fast Sites"
+```
+3. **Edit the content** (`site/src/2026-01-06-building-fast-sites.blog.md`):
+```markdown
+---
+title: Building Fast Sites
+excerpt: Learn how to build lightning-fast static sites
+---
+# Building Fast Sites
+Static sites are fast, secure, and easy to deploy.
+## Why Static?
+- **Speed** - No database queries
+- **Security** - No server-side code
+- **Scalability** - Just files on a CDN
+```
+4. **Build and view**:
+```bash
+jackdaw serve
+```
+## What's Next?
+- [Commands Reference](/commands.html) - All CLI commands
+- [Template Guide](/templates.html) - Master templating
+- [Content Guide](/content.html) - Organizing content
+- [Deployment](/deployment.html) - Go live

data/usejackdaw.com.site/site/src/index.page.md ADDED Viewed

@@ -0,0 +1,86 @@
+<div style="text-align: center; margin: 2rem 0;">
+  <img src="/jackdaw.png" alt="Jackdaw" style="max-width: 300px; height: auto;">
+</div>
+# Jackdaw ⚡️
+**Lightning-fast static site generator for Ruby**
+Jackdaw is a minimal, fast static site generator that emphasizes:
+- **Speed** - Build 600 files in under 1 second with parallel processing
+- **Convention over configuration** - Zero config required to get started
+- **Developer experience** - Live reload, incremental builds, intuitive CLI
+- **Simplicity** - Markdown + ERB templates, that's it
+## Quick Start
+```bash
+# Install
+gem install jackdaw
+# Create a new site
+jackdaw new my-blog
+cd my-blog.site
+# Start developing
+jackdaw serve
+```
+## Why Jackdaw?
+### ⚡️ Blazing Fast
+- Parallel processing for maximum speed
+- Incremental builds - only rebuild what changed
+- 693 files/second full build, 16,280 files/second incremental
+### 🎯 Convention Over Configuration
+- No configuration files needed
+- Intuitive project structure
+- Smart defaults that just work
+### 🛠 Great Developer Experience
+- Live reload development server
+- Helpful CLI commands
+- Clear error messages
+- Ruby 4.0 ready
+### 📦 Everything Included
+- Markdown with GitHub-flavored syntax
+- Syntax highlighting with Rouge
+- Partials and layouts
+- RSS/Atom feeds
+- Sitemap generation
+- SEO helpers
+## Key Features
+- **Markdown** - Write content in Markdown
+- **ERB Templates** - Flexible templating with Ruby
+- **Live Reload** - Changes appear instantly in browser
+- **Parallel Processing** - Multi-core performance
+- **Type-based Routing** - Automatic content organization
+- **Incremental Builds** - Only rebuild changed files
+- **RSS/Atom Feeds** - Automatic feed generation for blogs
+- **Sitemap** - SEO-friendly sitemap.xml
+- **Zero Config** - Convention over configuration
+## Learn More
+- [Installation](/installation.html) - Get Jackdaw up and running
+- [Getting Started](/getting-started.html) - Your first site in 5 minutes
+- [Commands](/commands.html) - Complete CLI reference
+- [Templates](/templates.html) - Master templating
+- [Content](/content.html) - Write and organize content
+## Performance Benchmarks
+| Operation | Time | Files/Second |
+|-----------|------|-------------|
+| Full build (600 files) | 0.87s | 693 |
+| Incremental build | 0.04s | 16,280 |
+| Cold start | 0.69s | 870 |
+## Open Source
+Jackdaw is MIT licensed and available on [GitHub](https://github.com/yourusername/jackdaw).

data/usejackdaw.com.site/site/src/installation.page.md ADDED Viewed

@@ -0,0 +1,63 @@
+# Installation
+## Requirements
+- Ruby 4.0 or later
+- Bundler (recommended)
+## Install from RubyGems
+The easiest way to install Jackdaw:
+```bash
+gem install jackdaw
+```
+Verify the installation:
+```bash
+jackdaw version
+```
+## Using Bundler
+Add to your `Gemfile`:
+```ruby
+gem 'jackdaw'
+```
+Then install:
+```bash
+bundle install
+```
+## From Source
+Clone the repository and build:
+```bash
+git clone https://github.com/yourusername/jackdaw.git
+cd jackdaw
+bundle install
+gem build jackdaw.gemspec
+gem install jackdaw-1.0.0.gem
+```
+## Dependencies
+Jackdaw automatically installs these dependencies:
+- **kramdown** (~> 2.4) - Markdown parsing
+- **kramdown-parser-gfm** (~> 1.1) - GitHub-flavored Markdown
+- **rouge** (~> 4.2) - Syntax highlighting
+- **thor** (~> 1.3) - CLI framework
+- **parallel** (~> 1.24) - Parallel processing
+- **puma** (~> 6.4) - Development server
+- **rack** (~> 3.0) - Web server interface
+- **listen** (~> 3.9) - File watching
+## Next Steps
+Once installed, [create your first site →](/getting-started.html)

data/usejackdaw.com.site/site/src/templates.page.md ADDED Viewed

@@ -0,0 +1,294 @@
+# Template Guide
+Learn how to create powerful, flexible templates with ERB.
+## Template Basics
+Templates are ERB files in `site/templates/` that wrap your content.
+**Basic template** (`site/templates/page.html.erb`):
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= title %></title>
+</head>
+<body>
+  <%= content %>
+</body>
+</html>
+```
+## Template Naming
+Templates match content types:
+- `page.html.erb` - Used by `*.page.md` files
+- `blog.html.erb` - Used by `*.blog.md` files
+- `post.html.erb` - Used by `*.post.md` files
+## Available Variables
+In templates, you have access to:
+### Content Variables
+```erb
+<%= content %>         <!-- Rendered HTML from Markdown -->
+<%= title %>           <!-- From first H1 or filename -->
+<%= date %>            <!-- Date object (if dated content) -->
+<%= type %>            <!-- Content type (page, blog, etc) -->
+<%= excerpt %>         <!-- First paragraph -->
+<%= raw_content %>     <!-- Original Markdown -->
+```
+## Layouts
+Create a layout for all pages:
+**`site/templates/layout.html.erb`:**
+```erb
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title><%= title %> - My Site</title>
+  <%= seo_tags %>
+  <link rel="stylesheet" href="/css/style.css">
+</head>
+<body>
+  <%= render_partial('nav') %>
+  <main>
+    <%= content %>
+  </main>
+  <%= render_partial('footer') %>
+</body>
+</html>
+```
+**Use in page template:**
+```erb
+<%= render_layout('layout') do %>
+  <article>
+    <h1><%= title %></h1>
+    <%= content %>
+  </article>
+<% end %>
+```
+## Partials
+Reusable template fragments in `site/templates/partials/`.
+**Create** (`site/templates/partials/nav.html.erb`):
+```erb
+<nav>
+  <ul>
+    <li><a href="/">Home</a></li>
+    <li><a href="/about.html">About</a></li>
+    <li><a href="/blog.html">Blog</a></li>
+  </ul>
+</nav>
+```
+**Use in templates:**
+```erb
+<%= render_partial('nav') %>
+```
+With variables:
+```erb
+<%= render_partial('card', { title: 'Hello', text: 'World' }) %>
+```
+## Collections
+Loop through content:
+```erb
+<h2>Recent Posts</h2>
+<ul>
+  <% collection('blog', limit: 5).each do |post| %>
+    <li>
+      <a href="/<%= post.output_path %>">
+        <%= post.title %>
+      </a>
+      <time><%= post.date.strftime('%B %d, %Y') %></time>
+    </li>
+  <% end %>
+</ul>
+```
+**Options:**
+- `limit: 10` - Maximum items
+- `sort: :date` - Sort by field (default: date)
+- `reverse: true` - Newest first (default)
+**Examples:**
+```erb
+<!-- All blog posts -->
+<% collection('blog').each do |post| %>
+  ...
+<% end %>
+<!-- Latest 3 posts -->
+<% collection('blog', limit: 3).each do |post| %>
+  ...
+<% end %>
+<!-- All pages -->
+<% collection('page').each do |page| %>
+  ...
+<% end %>
+```
+## SEO Helpers
+Built-in helpers for SEO:
+### Complete SEO Tags
+```erb
+<%= seo_tags %>
+```
+Generates:
+- Open Graph tags
+- Twitter Card tags
+- Canonical URL
+- Meta description
+### Individual Tags
+```erb
+<%= og_tags %>              <!-- Open Graph -->
+<%= twitter_tags %>         <!-- Twitter Cards -->
+<%= canonical_tag %>        <!-- Canonical URL -->
+<%= meta_description %>     <!-- Description meta tag -->
+```
+**With custom values:**
+```erb
+<%= og_tags(
+  title: "Custom Title",
+  description: "Custom description",
+  image: "/images/og-image.png"
+) %>
+```
+## Date Formatting
+```erb
+<!-- Full date -->
+<%= date.strftime('%B %d, %Y') %>
+<!-- January 06, 2026 -->
+<!-- Short date -->
+<%= date.strftime('%Y-%m-%d') %>
+<!-- 2026-01-06 -->
+<!-- Custom -->
+<%= date.strftime('%A, %b %e') %>
+<!-- Monday, Jan  6 -->
+```
+## Conditional Content
+```erb
+<% if defined?(date) && date %>
+  <time><%= date.strftime('%B %d, %Y') %></time>
+<% end %>
+<% if type == 'blog' %>
+  <span class="blog-badge">Blog Post</span>
+<% end %>
+```
+## Example Templates
+### Blog Post Template
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= title %> - My Blog</title>
+  <%= seo_tags %>
+  <link rel="stylesheet" href="/css/style.css">
+</head>
+<body>
+  <%= render_partial('nav') %>
+  <article class="blog-post">
+    <header>
+      <h1><%= title %></h1>
+      <time datetime="<%= date.iso8601 %>">
+        <%= date.strftime('%B %d, %Y') %>
+      </time>
+    </header>
+    <div class="content">
+      <%= content %>
+    </div>
+  </article>
+  <%= render_partial('footer') %>
+</body>
+</html>
+```
+### Blog Index Template
+```erb
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Blog</title>
+  <link rel="stylesheet" href="/css/style.css">
+</head>
+<body>
+  <%= render_partial('nav') %>
+  <h1>Blog</h1>
+  <div class="posts">
+    <% collection('blog', limit: 20).each do |post| %>
+      <article class="post-preview">
+        <h2>
+          <a href="/<%= post.output_path %>">
+            <%= post.title %>
+          </a>
+        </h2>
+        <time><%= post.date.strftime('%B %d, %Y') %></time>
+        <p><%= post.excerpt %></p>
+        <a href="/<%= post.output_path %>">Read more →</a>
+      </article>
+    <% end %>
+  </div>
+  <%= render_partial('footer') %>
+</body>
+</html>
+```
+## Tips
+1. **Keep it simple** - Start with basic templates
+2. **Use partials** - DRY up repeated HTML
+3. **Default values** - Use `||` for defaults:
+   ```erb
+   <%= title || 'Untitled' %>
+   ```
+4. **Check existence** - Use `defined?` for optional variables
+5. **Extract layouts** - Share structure across templates

data/usejackdaw.com.site/site/templates/_footer.html.erb ADDED Viewed

@@ -0,0 +1,12 @@
+<footer class="footer">
+  <div class="container">
+    <p>
+      Built with <a href="https://usejackdaw.com">Jackdaw</a> ⚡️
+      • <a href="https://github.com/BillyRuffian/jackdaw">GitHub</a>
+      • <a href="/feed.xml">RSS</a>
+    </p>
+    <p class="copyright">
+      © 2026 Jackdaw. MIT License.
+    </p>
+  </div>
+</footer>

data/usejackdaw.com.site/site/templates/_nav.html.erb ADDED Viewed

@@ -0,0 +1,19 @@
+<nav class="navbar">
+  <div class="container">
+    <div class="nav-brand">
+      <a href="/">
+        <img src="/squawk.png" alt="Jackdaw" class="logo">
+        Jackdaw
+      </a>
+    </div>
+    <ul class="nav-menu">
+      <li><a href="/installation.html">Install</a></li>
+      <li><a href="/getting-started.html">Get Started</a></li>
+      <li><a href="/commands.html">Commands</a></li>
+      <li><a href="/templates.html">Templates</a></li>
+      <li><a href="/content.html">Content</a></li>
+      <li><a href="/deployment.html">Deploy</a></li>
+      <li><a href="https://github.com/yourusername/jackdaw" class="github">GitHub</a></li>
+    </ul>
+  </div>
+</nav>

data/usejackdaw.com.site/site/templates/blog.html.erb ADDED Viewed

@@ -0,0 +1,7 @@
+<article>
+  <header>
+    <h1><%= title %></h1>
+    <time datetime="<%= date %>"><%= date.strftime('%B %d, %Y') %></time>
+  </header>
+  <%= content %>
+</article>

data/usejackdaw.com.site/site/templates/layout.html.erb ADDED Viewed

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title><%= title %> - <%= site_name %></title>
+  <% if defined?(description) && description %>
+    <meta name="description" content="<%= description %>">
+  <% end %>
+  <link rel="stylesheet" href="/css/style.css">
+  <link rel="alternate" type="application/rss+xml" title="Jackdaw RSS" href="/feed.xml">
+</head>
+<body>
+  <%= render 'nav' %>
+  <%= content %>
+  <%= render 'footer' %>
+</body>
+</html>

data/usejackdaw.com.site/site/templates/page.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<main class="container">
+  <article class="content">
+    <%= content %>
+  </article>
+</main>