jekyll-ai-domain-data 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a4e55e4ff4d2a8c9451f95a1e68c5f822622e10915f251893c4b6de7ab0c66c
+  data.tar.gz: f4954fabf7a33fa5df670a4c2f5a1522d716479636d8fc4cfcaa3030ec100e6d
+SHA512:
+  metadata.gz: 58c8e54f60ba26619a5b0f66967ae0039d9c1f798b6cc0c4582b976d72bbc6dda6429d53248c2938872a2d4346e367fa7c71724fdd53b895ed21bef09f4682e3
+  data.tar.gz: 32c99efb6f9f4484be08b4e1e799da5831d7016fd7c06335a2398c77a50a23669c5be6f6e72db0e87ae47b60c522f2f287ca6e9ba31eaa9cf7b0a0449a201dca

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# 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.1] - 2025-11-18
+
+### Added
+
+- Initial release
+- Automatic generation of `.well-known/domain-profile.json` during Jekyll build
+- Schema validation against AI Domain Data Standard v0.1.1
+- Liquid tag `{% ai_domain_data %}` for accessing domain data in templates
+- Support for all required and optional fields (name, description, website, contact, logo, entity_type, jsonld)
+- Automatic field mapping from Jekyll site configuration
+- Validation error reporting in build output
+
+### Changed
+
+- N/A (initial release)
+
+### Fixed
+
+- N/A (initial release)
+

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Dylan Larson
+
+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,188 @@
+# jekyll-ai-domain-data
+
+A Jekyll plugin that automatically generates and validates `domain-profile.json` files according to the [AI Domain Data Standard](https://ai-domain-data.org) v0.1.1.
+
+The AI Domain Data Standard is an open, vendor-neutral format for publishing authoritative domain identity data for AI systems, search engines, and automated agents. This plugin makes it easy to add AI Domain Data support to your Jekyll site.
+
+## Installation
+
+Add this line to your site's `Gemfile`:
+
+```ruby
+gem "jekyll-ai-domain-data"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install jekyll-ai-domain-data
+```
+
+Then add the plugin to your `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll-ai-domain-data
+```
+
+## Configuration
+
+Add an `ai_domain_data` section to your `_config.yml`:
+
+```yaml
+ai_domain_data:
+  enabled: true  # Set to false to disable generation
+  name: "Your Site Name"
+  description: "A concise description of your site or organization"
+  website: "https://example.com"  # Optional, defaults to site.url
+  contact: "contact@example.com"
+  logo: "https://example.com/logo.png"  # Optional
+  entity_type: "Organization"  # Optional: Organization, Person, Blog, NGO, Community, Project, CreativeWork, SoftwareApplication, or Thing
+  jsonld:  # Optional: Embedded JSON-LD block
+    "@context": "https://schema.org"
+    "@type": "Organization"
+    "name": "Your Site Name"
+    "url": "https://example.com"
+    "email": "contact@example.com"
+```
+
+### Field Mapping
+
+The plugin will automatically use values from your Jekyll config if not explicitly set:
+
+- `name`: Falls back to `site.title` or `site.name`
+- `description`: Falls back to `site.description`
+- `website`: Falls back to `site.url` (will be prefixed with `https://` if missing)
+- `contact`: Falls back to `site.email`
+
+### Minimal Configuration
+
+If you already have basic site metadata in `_config.yml`, you can use a minimal configuration:
+
+```yaml
+ai_domain_data:
+  contact: "contact@example.com"  # Required, no fallback
+```
+
+All other fields will be pulled from your existing Jekyll configuration.
+
+## Usage
+
+### Automatic Generation
+
+Once configured, the plugin automatically generates `.well-known/domain-profile.json` during site build. The file will be available at:
+
+```
+https://yourdomain.com/.well-known/domain-profile.json
+```
+
+### Liquid Tags
+
+You can also access domain data in your templates using the `ai_domain_data` tag:
+
+```liquid
+{% ai_domain_data name %}        <!-- Outputs: Your Site Name -->
+{% ai_domain_data description %} <!-- Outputs: Your description -->
+{% ai_domain_data website %}     <!-- Outputs: https://example.com -->
+{% ai_domain_data contact %}     <!-- Outputs: contact@example.com -->
+{% ai_domain_data logo %}        <!-- Outputs: https://example.com/logo.png -->
+{% ai_domain_data entity_type %} <!-- Outputs: Organization -->
+{% ai_domain_data json %}        <!-- Outputs: Pretty-printed JSON -->
+{% ai_domain_data json_compact %} <!-- Outputs: Compact JSON -->
+{% ai_domain_data %}             <!-- Outputs: Pretty-printed full JSON -->
+```
+
+### Example: Embedding in HTML
+
+```html
+<script type="application/ld+json">
+{% ai_domain_data json %}
+</script>
+```
+
+## Validation
+
+The plugin validates your configuration against the AI Domain Data Standard schema before generating the file. If validation fails, you'll see warnings in the build output and the file won't be generated.
+
+Common validation errors:
+
+- Missing required fields (`name`, `description`, `website`, `contact`)
+- Invalid `entity_type` (must be a valid schema.org @type value)
+- Invalid `jsonld` structure (must include `@context: "https://schema.org"` and `@type`)
+
+## Examples
+
+### Basic Configuration
+
+```yaml
+# _config.yml
+title: "My Awesome Blog"
+description: "A blog about web development and technology"
+url: "https://myblog.com"
+email: "hello@myblog.com"
+
+ai_domain_data:
+  contact: "hello@myblog.com"
+  entity_type: "Blog"
+```
+
+### Complete Configuration
+
+```yaml
+# _config.yml
+ai_domain_data:
+  name: "Acme Corporation"
+  description: "Leading provider of innovative solutions"
+  website: "https://acme.com"
+  contact: "info@acme.com"
+  logo: "https://acme.com/logo.png"
+  entity_type: "Organization"
+  jsonld:
+    "@context": "https://schema.org"
+    "@type": "Organization"
+    "name": "Acme Corporation"
+    "url": "https://acme.com"
+    "logo": "https://acme.com/logo.png"
+    "email": "info@acme.com"
+    "description": "Leading provider of innovative solutions"
+    "foundingDate": "2020-01-01"
+    "numberOfEmployees": "50-100"
+```
+
+## Requirements
+
+- Jekyll >= 3.8, < 5.0
+- Ruby >= 2.7.0
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ai-domain-data/jekyll-ai-domain-data.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Related Projects
+
+- [AI Domain Data Standard](https://ai-domain-data.org) - The specification this plugin implements
+- [AI Domain Data CLI](https://github.com/ai-domain-data/spec/tree/main/packages/cli) - Command-line tool for generating and validating domain profiles
+- [AI Domain Data Resolver SDK](https://github.com/ai-domain-data/spec/tree/main/packages/resolver) - TypeScript/Node.js SDK for resolving domain profiles
+
+## Support
+
+For issues, questions, or contributions, please visit:
+- GitHub Issues: https://github.com/ai-domain-data/jekyll-ai-domain-data/issues
+- AI Domain Data Standard: https://ai-domain-data.org
+

data/lib/jekyll-ai-domain-data/generator.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "json"
+require "fileutils"
+require_relative "validator"
+require_relative "schema"
+
+module Jekyll
+  module AIDomainData
+    # Jekyll Generator that creates .well-known/domain-profile.json
+    class Generator < Jekyll::Generator
+      safe true
+      priority :low
+
+      def generate(site)
+        config = site.config["ai_domain_data"] || {}
+        
+        # Skip if disabled
+        return if config["enabled"] == false
+
+        # Build domain profile from config
+        profile = build_profile(site, config)
+        
+        # Validate the profile
+        validation_result = Validator.validate(profile)
+        
+        if validation_result[:valid]
+          # Create the .well-known directory and file
+          create_domain_profile(site, profile)
+          Jekyll.logger.info "AI Domain Data:", "Generated .well-known/domain-profile.json"
+        else
+          Jekyll.logger.warn "AI Domain Data:", "Validation failed:"
+          validation_result[:errors].each do |error|
+            Jekyll.logger.warn "", "  - #{error}"
+          end
+          Jekyll.logger.warn "", "Skipping domain-profile.json generation. Fix configuration errors and rebuild."
+        end
+      end
+
+      private
+
+      def build_profile(site, config)
+        # Get site URL (required)
+        website = config["website"] || site.config["url"]
+        if website && !website.start_with?("http")
+          website = "https://#{website}"
+        end
+
+        # Build required fields
+        profile = {
+          "spec" => "https://ai-domain-data.org/spec/v0.1",
+          "name" => config["name"] || site.config["title"] || site.config["name"] || "Untitled Site",
+          "description" => config["description"] || site.config["description"] || "",
+          "website" => website || "",
+          "contact" => config["contact"] || site.config["email"] || ""
+        }
+
+        # Add optional fields if provided
+        profile["logo"] = config["logo"] if config["logo"]
+        profile["entity_type"] = config["entity_type"] if config["entity_type"]
+        profile["jsonld"] = config["jsonld"] if config["jsonld"]
+
+        profile
+      end
+
+      def create_domain_profile(site, profile)
+        # Create .well-known directory in source
+        well_known_source = File.join(site.source, ".well-known")
+        FileUtils.mkdir_p(well_known_source) unless Dir.exist?(well_known_source)
+
+        # Write domain-profile.json to source
+        output_path = File.join(well_known_source, "domain-profile.json")
+        File.write(output_path, JSON.pretty_generate(profile) + "\n")
+
+        # Register the file with Jekyll so it gets copied to the destination
+        # Check if it's already registered to avoid duplicates
+        existing = site.static_files.find do |file|
+          file.relative_path == "/.well-known/domain-profile.json"
+        end
+        
+        unless existing
+          site.static_files << Jekyll::StaticFile.new(
+            site,
+            site.source,
+            ".well-known",
+            "domain-profile.json"
+          )
+        end
+      end
+    end
+  end
+end
+

data/lib/jekyll-ai-domain-data/schema.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module AIDomainData
+    # JSON Schema for AI Domain Data Standard v0.1.1
+    SCHEMA = {
+      "$id" => "https://ai-domain-data.org/spec/schema-v0.1.json",
+      "title" => "AI Domain Data v0.1.1",
+      "type" => "object",
+      "additionalProperties" => false,
+      "required" => %w[spec name description website contact],
+      "properties" => {
+        "spec" => {
+          "type" => "string",
+          "const" => "https://ai-domain-data.org/spec/v0.1",
+          "description" => "Canonical URL for the AI Domain Data specification version."
+        },
+        "name" => {
+          "type" => "string",
+          "minLength" => 1,
+          "description" => "Public-facing name for the site, organization, or publisher."
+        },
+        "description" => {
+          "type" => "string",
+          "minLength" => 1,
+          "description" => "Concise description used by AI agents to understand the domain."
+        },
+        "website" => {
+          "type" => "string",
+          "format" => "uri",
+          "description" => "Primary website URL for the domain."
+        },
+        "logo" => {
+          "type" => "string",
+          "format" => "uri",
+          "description" => "Optional URL to a logo or representative image."
+        },
+        "contact" => {
+          "type" => "string",
+          "minLength" => 1,
+          "description" => "Preferred contact point (email or URL)."
+        },
+        "entity_type" => {
+          "type" => "string",
+          "enum" => %w[
+            Organization
+            Person
+            Blog
+            NGO
+            Community
+            Project
+            CreativeWork
+            SoftwareApplication
+            Thing
+          ],
+          "description" => "Optional schema.org @type value for entity classification."
+        },
+        "jsonld" => {
+          "type" => "object",
+          "description" => "Optional embedded JSON-LD block for schema.org alignment.",
+          "properties" => {
+            "@context" => {
+              "type" => "string",
+              "const" => "https://schema.org"
+            },
+            "@type" => {
+              "type" => "string",
+              "minLength" => 1
+            }
+          },
+          "required" => %w[@context @type],
+          "additionalProperties" => true
+        }
+      }
+    }.freeze
+  end
+end
+

data/lib/jekyll-ai-domain-data/tags.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Jekyll
+  module AIDomainData
+    # Liquid tag to output domain profile data
+    # Usage: {% ai_domain_data name %} or {% ai_domain_data json %}
+    class DomainDataTag < Liquid::Tag
+      def initialize(tag_name, field, tokens)
+        super
+        @field = field&.strip
+      end
+
+      def render(context)
+        site = context.registers[:site]
+        config = site.config["ai_domain_data"] || {}
+        
+        # Build profile (same logic as generator)
+        profile = build_profile(site, config)
+        
+        case @field
+        when "name"
+          profile["name"] || ""
+        when "description"
+          profile["description"] || ""
+        when "website"
+          profile["website"] || ""
+        when "contact"
+          profile["contact"] || ""
+        when "logo"
+          profile["logo"] || ""
+        when "entity_type"
+          profile["entity_type"] || ""
+        when "json"
+          JSON.pretty_generate(profile)
+        when "json_compact"
+          JSON.generate(profile)
+        else
+          # Return all data as JSON if no field specified
+          JSON.pretty_generate(profile)
+        end
+      end
+
+      private
+
+      def build_profile(site, config)
+        website = config["website"] || site.config["url"]
+        if website && !website.start_with?("http")
+          website = "https://#{website}"
+        end
+
+        profile = {
+          "spec" => "https://ai-domain-data.org/spec/v0.1",
+          "name" => config["name"] || site.config["title"] || site.config["name"] || "Untitled Site",
+          "description" => config["description"] || site.config["description"] || "",
+          "website" => website || "",
+          "contact" => config["contact"] || site.config["email"] || ""
+        }
+
+        profile["logo"] = config["logo"] if config["logo"]
+        profile["entity_type"] = config["entity_type"] if config["entity_type"]
+        profile["jsonld"] = config["jsonld"] if config["jsonld"]
+
+        profile
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("ai_domain_data", Jekyll::AIDomainData::DomainDataTag)
+

data/lib/jekyll-ai-domain-data/validator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "json-schema"
+require_relative "schema"
+
+module Jekyll
+  module AIDomainData
+    # Validates domain profile data against the AI Domain Data Standard schema
+    class Validator
+      def self.validate(data)
+        errors = []
+        
+        begin
+          JSON::Validator.validate!(SCHEMA, data, strict: false)
+          { valid: true, errors: [] }
+        rescue JSON::Schema::ValidationError => e
+          errors << e.message
+          { valid: false, errors: errors }
+        rescue JSON::Schema::SchemaError => e
+          errors << "Schema error: #{e.message}"
+          { valid: false, errors: errors }
+        rescue StandardError => e
+          errors << "Validation error: #{e.message}"
+          { valid: false, errors: errors }
+        end
+      end
+
+      def self.validate!(data)
+        result = validate(data)
+        unless result[:valid]
+          raise ValidationError, "Domain profile validation failed:\n  #{result[:errors].join("\n  ")}"
+        end
+        result
+      end
+    end
+
+    # Custom error class for validation failures
+    class ValidationError < StandardError; end
+  end
+end
+

data/lib/jekyll-ai-domain-data/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module AIDomainData
+    VERSION = "0.1.1"
+  end
+end
+

data/lib/jekyll-ai-domain-data.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+module Jekyll
+  module AIDomainData
+    autoload :Generator, "jekyll-ai-domain-data/generator"
+    autoload :Validator, "jekyll-ai-domain-data/validator"
+    autoload :Schema, "jekyll-ai-domain-data/schema"
+    autoload :DomainDataTag, "jekyll-ai-domain-data/tags"
+    autoload :VERSION, "jekyll-ai-domain-data/version"
+  end
+end
+
+# Explicitly require the generator and tags so Jekyll can discover them
+require_relative "jekyll-ai-domain-data/generator"
+require_relative "jekyll-ai-domain-data/tags"
+

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-ai-domain-data
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- AI Domain Data Standard Contributors
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |
+  A Jekyll plugin that automatically generates and validates domain-profile.json files
+  according to the AI Domain Data Standard v0.1.1. The plugin creates the file at
+  .well-known/domain-profile.json during site generation and provides Liquid tags
+  for accessing domain data in your templates.
+email:
+- info@ascendingwebservices.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/jekyll-ai-domain-data.rb
+- lib/jekyll-ai-domain-data/generator.rb
+- lib/jekyll-ai-domain-data/schema.rb
+- lib/jekyll-ai-domain-data/tags.rb
+- lib/jekyll-ai-domain-data/validator.rb
+- lib/jekyll-ai-domain-data/version.rb
+homepage: https://github.com/ai-domain-data/jekyll-ai-domain-data
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ai-domain-data/jekyll-ai-domain-data/issues
+  changelog_uri: https://github.com/ai-domain-data/jekyll-ai-domain-data/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/ai-domain-data/jekyll-ai-domain-data#readme
+  source_code_uri: https://github.com/ai-domain-data/jekyll-ai-domain-data
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Jekyll plugin for generating AI Domain Data Standard domain-profile.json
+  files
+test_files: []