https://github.com/ai-domain-data/jekyll-ai-domain-data
Jekyll plugin for generating AI Domain Data Standard domain-profile.json files. Automatically creates and validates .well-known/domain-profile.json during site generation.
https://github.com/ai-domain-data/jekyll-ai-domain-data
jekyll jekyll-generator jekyll-plugin static-site-generator
Last synced: 2 months ago
JSON representation
Jekyll plugin for generating AI Domain Data Standard domain-profile.json files. Automatically creates and validates .well-known/domain-profile.json during site generation.
- Host: GitHub
- URL: https://github.com/ai-domain-data/jekyll-ai-domain-data
- Owner: ai-domain-data
- License: mit
- Created: 2025-11-18T22:06:41.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-11-20T17:47:42.000Z (7 months ago)
- Last Synced: 2025-12-13T12:41:19.968Z (6 months ago)
- Topics: jekyll, jekyll-generator, jekyll-plugin, static-site-generator
- Language: Ruby
- Homepage:
- Size: 16.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jekyll-plugins - **AI Domain Data** - ai-domain-data](https://rubygems.org/gems/jekyll-ai-domain-data)) -- Automatically generates AI Domain Data Standard domain-profile.json files for AI systems, search engines, and automated agents (Other)
README
# 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 %}
{% ai_domain_data description %}
{% ai_domain_data website %}
{% ai_domain_data contact %}
{% ai_domain_data logo %}
{% ai_domain_data entity_type %}
{% ai_domain_data json %}
{% ai_domain_data json_compact %}
{% ai_domain_data %}
```
### Example: Embedding in HTML
```html
{% ai_domain_data json %}
```
### CORS Configuration
To allow cross-origin requests (required for tools like the [AI Domain Data checker](https://ai-domain-data.org/checker)), you need to configure CORS headers at your hosting provider level. The plugin generates a static file, so headers must be set by your web server or hosting platform.
#### GitHub Pages
GitHub Pages doesn't support custom headers. The file will be accessible, but cross-origin requests may be limited. Consider using a different hosting provider if CORS is required.
#### Netlify
Add to `netlify.toml` in your site root:
```toml
[[headers]]
for = "/.well-known/domain-profile.json"
[headers.values]
Access-Control-Allow-Origin = "*"
Access-Control-Allow-Methods = "GET, OPTIONS"
Access-Control-Allow-Headers = "Content-Type"
```
#### Apache
Add to `.htaccess` in your site root:
```apache
Header set Access-Control-Allow-Origin "*"
Header set Access-Control-Allow-Methods "GET, OPTIONS"
Header set Access-Control-Allow-Headers "Content-Type"
```
#### Nginx
Add to your server configuration:
```nginx
location ~* \.well-known/domain-profile\.json$ {
add_header Access-Control-Allow-Origin *;
add_header Access-Control-Allow-Methods "GET, OPTIONS";
add_header Access-Control-Allow-Headers "Content-Type";
}
```
#### Vercel
Add to `vercel.json` in your site root:
```json
{
"headers": [
{
"source": "/.well-known/domain-profile.json",
"headers": [
{ "key": "Access-Control-Allow-Origin", "value": "*" },
{ "key": "Access-Control-Allow-Methods", "value": "GET, OPTIONS" },
{ "key": "Access-Control-Allow-Headers", "value": "Content-Type" }
]
}
]
}
```
**Note:** Without CORS headers, the domain profile will still be accessible via direct URL, but cross-origin tools (like the checker) may be blocked by browser security policies.
## 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