jekyll-baserow-headless-cms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea0b75ace4c5a6878f34fc412bec22347460a17f4dcbc0e2d3088e454c695a3f
+  data.tar.gz: 9d3fb852f8211644eb4fbbf5e7812035e925b4743756861a69a22ebd980e17cb
+SHA512:
+  metadata.gz: 789951bea1a8165ddd6f545ef66c3105f202abe2e548d43b90e6355bc80c8dbd23a063779915ac18eae8bf30ddc29ae0626e48e4b49334f8cec125bc16ef97ab
+  data.tar.gz: 1640cbd21456c4bd7062ded704b13547eeeda1aef71e5a1a66282f384d53bd2c5f4edac27776063ff8e286403fd17731b79a997594bd4daf0c1b2bfd81f310c6

data/.claude/settings.json

@@ -0,0 +1,12 @@
+{
+  "enabledMcpjsonServers": ["github", "context7", "chrome-devtools"],
+  "disabledMcpjsonServers": [
+    "figma-desktop",
+    "sentry",
+    "n8n-mcp-staging",
+    "n8n-mcp-prod",
+    "MCP_DOCKER",
+    "excalidraw-staging",
+    "pencil"
+  ]
+}

data/.mcp.json

@@ -0,0 +1,68 @@
+{
+  "mcpServers": {
+    "github": {
+      "type": "http",
+      "url": "https://api.githubcopilot.com/mcp/",
+      "headers": {
+        "Authorization": "Bearer ${GITHUB_MCP_PAT}"
+      }
+    },
+    "context7": {
+      "type": "http",
+      "url": "https://mcp.context7.com/mcp",
+      "headers": {
+        "CONTEXT7_API_KEY": "${CONTEXT7_API_KEY}"
+      }
+    },
+    "chrome-devtools": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["chrome-devtools-mcp@latest"],
+      "env": {}
+    },
+    "figma-desktop": {
+      "type": "http",
+      "url": "http://127.0.0.1:3845/mcp"
+    },
+    "sentry": {
+      "type": "http",
+      "url": "https://mcp.sentry.dev/mcp"
+    },
+    "n8n-mcp-staging": {
+      "command": "npx",
+      "args": ["n8n-mcp"],
+      "env": {
+        "MCP_MODE": "stdio",
+        "LOG_LEVEL": "error",
+        "DISABLE_CONSOLE_OUTPUT": "true",
+        "N8N_API_URL": "https://n8n.staging.maxime-lenne.fr/",
+        "N8N_API_KEY": "${N8N_STAGING_API_KEY}"
+      }
+    },
+    "n8n-mcp-prod": {
+      "command": "npx",
+      "args": ["n8n-mcp"],
+      "env": {
+        "MCP_MODE": "stdio",
+        "LOG_LEVEL": "error",
+        "DISABLE_CONSOLE_OUTPUT": "true",
+        "N8N_API_URL": "https://n8n.maxime-lenne.fr/",
+        "N8N_API_KEY": "${N8N_PROD_API_KEY}"
+      }
+    },
+    "MCP_DOCKER": {
+      "command": "docker",
+      "args": ["mcp", "gateway", "run"]
+    },
+    "excalidraw-staging": {
+      "type": "http",
+      "url": "https://excalidraw.staging.maxime-lenne.fr/mcp"
+    },
+    "pencil": {
+      "type": "stdio",
+      "command": "/Applications/Pencil.app/Contents/Resources/app.asar.unpacked/out/mcp-server-darwin-arm64",
+      "args": ["--app", "desktop"],
+      "env": {}
+    }
+  }
+}

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,87 @@
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+
+# Naming
+Naming/FileName:
+  Exclude:
+    - 'lib/jekyll-baserow-headless-cms.rb'
+
+# Gemspec
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+# Metrics
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Max: 35
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Metrics/MethodLength:
+  Max: 45
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/ModuleLength:
+  Max: 250
+
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Style
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# Layout
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+# Lint
+Lint/DuplicateBranch:
+  Enabled: false
+
+# RSpec
+RSpec/ExampleLength:
+  Max: 25
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/IndexedLet:
+  Enabled: false
+
+# RSpec (Capybara-specific matcher rule, renamed under the RSpec department in rubocop-rspec 3.x)
+RSpec/PredicateMatcher:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-08-19
+
+### Added
+
+- Initial release of jekyll-baserow-headless-cms, adapted from
+  [jekyll-notion-cms](https://github.com/maxime-lenne/jekyll-notion-cms) to use
+  [Baserow](https://baserow.io) as the content source instead of Notion
+- Configurable collections via `_config.yml`
+- Support for Baserow field types:
+  - Text, Long text, Number, Boolean
+  - Date, Created on, Last modified
+  - Single select, Multiple select
+  - URL, Email, Phone number
+  - File, Rating, Count
+  - Link to table, Lookup, Formula
+- Multiple data organizers:
+  - `simple_list` - Sorted array of items
+  - `items_by_category` - Items grouped by category (skills, products, etc.)
+  - `grouped_by` - Items grouped by a field
+  - `nested` - Hierarchical tree structure
+- Automatic fallback to Jekyll collections
+- Pagination support for large tables
+- Data file caching to avoid unnecessary regeneration
+- Comprehensive logging
+- Support for self-hosted Baserow instances via `BASEROW_API_URL`
+
+### Security
+
+- Secure handling of Baserow API tokens via environment variables
+
+[0.1.0]: https://github.com/maxime-lenne/jekyll-baserow-headless-cms/releases/tag/v0.1.0

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-baserow-headless-cms.gemspec
+gemspec
+
+group :development do
+  gem 'pry', '~> 0.14'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Maxime Lenne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,291 @@
+# Jekyll Baserow Headless CMS
+
+<p align="center">
+  <img src="https://cdn.simpleicons.org/baserow" alt="Baserow" width="80" height="80" />
+  <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/jekyll/jekyll-original.svg" alt="Jekyll" width="80" height="80" />
+  <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/githubactions/githubactions-original-wordmark.svg" alt="Github Action" width="80" height="80" />
+</p>
+
+<p align="center">
+  <strong>Use Baserow as a headless CMS for your Jekyll static site</strong>
+</p>
+
+<p align="center">
+  <a href="https://badge.fury.io/rb/jekyll-baserow-headless-cms"><img src="https://badge.fury.io/rb/jekyll-baserow-headless-cms.svg" alt="Gem Version" /></a>
+  <a href="https://github.com/maxime-lenne/jekyll-baserow-headless-cms/actions/workflows/ci.yml"><img src="https://github.com/maxime-lenne/jekyll-baserow-headless-cms/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a>
+</p>
+
+---
+
+A configurable Jekyll plugin that fetches content from [Baserow](https://baserow.io) tables and makes it available as Jekyll data files. Perfect for building landing pages, portfolios, blogs, and resumes with Baserow as your content management system.
+
+This project is a Baserow-flavored sibling of [jekyll-notion-cms](https://github.com/maxime-lenne/jekyll-notion-cms) — same architecture and organizer system, adapted for Baserow's REST API and field model.
+
+## Features
+
+- **Configurable Collections**: Define any number of Baserow table collections via `_config.yml`
+- **Multiple Organizers**: Support for different data organization patterns (simple list, grouped, skills by category, nested)
+- **Common Field Types**: Support for the main Baserow field types (text, number, date, select, multi-select, link to table, lookups, files, etc.)
+- **Fallback System**: Automatic fallback to Jekyll collections when Baserow is unavailable
+- **Pagination**: Handles large tables with automatic pagination
+- **Caching**: Intelligent file caching to avoid unnecessary regenerations
+- **Self-hosted friendly**: Works with baserow.io or any self-hosted Baserow instance via `BASEROW_API_URL`
+
+
+## Architecture
+
+<p align="center">
+  <img src="docs/architecture.png" alt="Jekyll Notion CMS Architecture" width="800" />
+</p>
+
+The diagram above shows how Jekyll Baserow Headless CMS integrates with your workflow:
+
+1. **Content editing** in Baserow databases
+2. **Change detection** via Baserow webhook
+3. **Build trigger** through GitHub Actions workflow_dispatch
+4. **Static site generation** with Jekyll + jekyll-baserow-headless-cms
+5. **Deployment** to GitHub Pages (or any static host)
+
+## Use Cases
+
+### Landing Page
+
+Build dynamic landing pages with content managed entirely in Baserow:
+
+| Content Type | Baserow Table | Description |
+|--------------|----------------|--------------|
+| **Services** | Services | List your offerings with icons, descriptions, and pricing |
+| **Testimonials** | Testimonials | Client reviews with photos, quotes, and ratings |
+| **Team** | Team | Team member profiles with photos and bios |
+| **FAQ** | FAQ | Frequently asked questions organized by category |
+
+### Portfolio
+
+Showcase your work with a portfolio powered by Baserow:
+
+| Content Type | Baserow Table | Description |
+|--------------|----------------|--------------|
+| **Projects** | Projects | Portfolio pieces with images, descriptions, and links |
+| **Skills** | Skills | Technical skills organized by category with proficiency levels |
+| **Certifications** | Certifications | Professional certifications and badges |
+
+### Blog
+
+Run a full-featured blog with Baserow as your writing tool:
+
+| Content Type | Baserow Table | Description |
+|--------------|----------------|--------------|
+| **Posts** | Blog | Articles with rich text, tags, and publication dates |
+| **Categories** | Categories | Blog categories for organization |
+| **Authors** | Authors | Author profiles for multi-author blogs |
+
+### Resume / CV
+
+Create a dynamic online resume:
+
+| Content Type | Baserow Table | Description |
+|--------------|----------------|--------------|
+| **Experiences** | Experiences | Work history with dates, companies, and descriptions |
+| **Education** | Education | Academic background and degrees |
+| **Skills** | Skills | Technical and soft skills with proficiency |
+| **Languages** | Languages | Language proficiencies |
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-baserow-headless-cms'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install jekyll-baserow-headless-cms
+```
+
+## Quick Start
+
+### 1. Create a Baserow API token
+
+1. Go to your Baserow workspace settings
+2. Create a new **Database token** scoped to the workspace/database you want to sync
+3. Copy the token
+
+### 2. Configure Environment Variables
+
+```bash
+export BASEROW_TOKEN=your_database_token
+export BASEROW_EXPERIENCES_TABLE=your_table_id
+export BASEROW_BLOG_TABLE=your_blog_table_id
+
+# Optional: only needed for a self-hosted Baserow instance
+export BASEROW_API_URL=https://baserow.example.com
+```
+
+### 3. Add Configuration to `_config.yml`
+
+```yaml
+baserow:
+  enabled: true
+
+  collections:
+    experiences:
+      table_env: BASEROW_EXPERIENCES_TABLE
+      data_file: baserow_experiences.yml
+      organizer: simple_list
+      sort_by: order
+      fields:
+        - { name: Title, type: text }
+        - { name: Company, type: text }
+        - { name: Start Date, type: date, key: start_date }
+        - { name: Current, type: boolean }
+        - { name: Tags, type: multi_select }
+
+    blog_posts:
+      table_env: BASEROW_BLOG_TABLE
+      data_file: baserow_blog_posts.yml
+      organizer: simple_list
+      sort_by: published_at
+      sort_order: desc
+      fields:
+        - { name: Title, type: text }
+        - { name: Slug, type: text }
+        - { name: Language, type: single_select }
+        - { name: Published At, type: date, key: published_at }
+        - { name: Status, type: single_select }
+        - { name: Excerpt, type: long_text }
+        - { name: Tags, type: multi_select }
+```
+
+### 4. Use Data in Templates
+
+```liquid
+{% for exp in site.data.baserow_experiences %}
+  <h3>{{ exp.title }}</h3>
+  <p>{{ exp.company }} - {{ exp.start_date }}</p>
+{% endfor %}
+```
+
+## Examples & Configuration
+
+For detailed examples and configuration reference, see **[Examples & Configuration](docs/EXAMPLES_AND_CONFIGURATION.md)**.
+
+**Examples included:**
+- Projects Table (portfolio, case studies)
+- Services Table (freelancers, agencies)
+- Testimonials Table (client reviews)
+- Skills Table (technical expertise)
+
+**Configuration reference:**
+- Collection options
+- Organizer types (`simple_list`, `items_by_category`, `grouped_by`, `nested`)
+- Supported field types
+- Field configuration syntax
+
+## Fallback System
+
+When Baserow is unavailable, the plugin automatically falls back to Jekyll collections:
+
+1. **No `BASEROW_TOKEN`**: Uses all Jekyll collections
+2. **Missing table ID**: Uses fallback for that collection
+3. **API Error**: Falls back gracefully with error logging
+
+Create fallback collections in `_collections/`:
+
+```
+_collections/
+├── _experiences/
+│   ├── experience-1.md
+│   └── experience-2.md
+└── _blog_posts/
+    └── my-post.md
+```
+
+## Automation & Deployment
+
+### GitHub Actions Workflow
+
+Copy the workflow template to your repository:
+
+```bash
+cp docs/templates/github-actions_baserow-sync.yml .github/workflows/baserow-sync.yml
+```
+
+**Full workflow file:** [`docs/templates/github-actions_baserow-sync.yml`](docs/templates/github-actions_baserow-sync.yml)
+
+### Automatic Sync with Baserow Webhooks
+
+Unlike Notion, Baserow tables support **native webhooks** with custom HTTP headers, so they
+can call the GitHub REST API directly — no relay or serverless function needed:
+
+1. **Create a GitHub Personal Access Token** (fine-grained, scoped to this repo) with the
+   **Actions: Read and write** permission. This is what lets Baserow trigger the workflow.
+2. In Baserow, open your table → **Webhooks** → **Create webhook**:
+   - **Events**: `Rows created`, `Rows updated`, `Rows deleted` (pick what you need)
+   - **URL**: `https://api.github.com/repos/<owner>/<repo>/actions/workflows/baserow-sync.yml/dispatches`
+   - **Method**: `POST`
+   - **Headers**:
+     - `Authorization: Bearer <your PAT>`
+     - `Accept: application/vnd.github+json`
+   - **Body** (JSON): `{"ref": "main"}`
+
+   The `baserow_event`/`table_id` inputs in the template have defaults, so a minimal
+   `{"ref": "main"}` body is enough — those inputs mainly help distinguish manual/CLI runs.
+3. Repeat per table you want to watch (Baserow webhooks are scoped to one table).
+
+Or trigger the workflow manually via GitHub CLI:
+
+```bash
+gh workflow run baserow-sync.yml \
+  -f baserow_event=manual \
+  -f table_id=all
+```
+
+Or via the GitHub Actions UI by clicking "Run workflow" on the Actions tab.
+
+## Development
+
+After checking out the repo:
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests
+bundle exec rspec
+
+# Run linter
+bundle exec rubocop
+
+# Run console
+bundle exec rake console
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/maxime-lenne/jekyll-baserow-headless-cms.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-feature`)
+3. Commit your changes (`git commit -am 'Add my feature'`)
+4. Push to the branch (`git push origin feature/my-feature`)
+5. Create a Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Author
+
+**Maxime Lenne** - [maxime-lenne.fr](https://maxime-lenne.fr)
+
+- GitHub: [@maxime-lenne](https://github.com/maxime-lenne)
+- LinkedIn: [maximelenne](https://linkedin.com/in/maximelenne)

data/Rakefile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+desc 'Run all tests and linters'
+task ci: %i[spec rubocop]
+
+desc 'Build and install gem locally'
+task :install_local do
+  sh 'gem build jekyll-baserow-headless-cms.gemspec'
+  sh 'gem install jekyll-baserow-headless-cms-*.gem'
+end
+
+desc 'Run console with gem loaded'
+task :console do
+  require 'pry'
+  require_relative 'lib/jekyll-baserow-headless-cms'
+  Pry.start
+end