{"id":25450861,"url":"https://github.com/cloudcannon/cloudcannon-jekyll","last_synced_at":"2025-07-10T00:03:46.754Z","repository":{"id":45542915,"uuid":"219415682","full_name":"CloudCannon/cloudcannon-jekyll","owner":"CloudCannon","description":":electric_plug: A Jekyll plugin that creates CloudCannon build information.","archived":false,"fork":false,"pushed_at":"2024-03-27T22:27:00.000Z","size":319,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-05T07:17:34.390Z","etag":null,"topics":["cloudcannon","cms","jekyll","jekyll-plugin","ssg","static-site-generator"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CloudCannon.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-04T04:15:04.000Z","updated_at":"2022-11-03T23:21:11.000Z","dependencies_parsed_at":"2023-10-12T03:20:53.067Z","dependency_job_id":"147fc16d-3e07-4868-8813-0762839505be","html_url":"https://github.com/CloudCannon/cloudcannon-jekyll","commit_stats":{"total_commits":143,"total_committers":5,"mean_commits":28.6,"dds":"0.13286713286713292","last_synced_commit":"a6051a82f929ed52f410c1fbe353dfc1e2d036ac"},"previous_names":[],"tags_count":75,"template":false,"template_full_name":null,"purl":"pkg:github/CloudCannon/cloudcannon-jekyll","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CloudCannon%2Fcloudcannon-jekyll","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CloudCannon%2Fcloudcannon-jekyll/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CloudCannon%2Fcloudcannon-jekyll/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CloudCannon%2Fcloudcannon-jekyll/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CloudCannon","download_url":"https://codeload.github.com/CloudCannon/cloudcannon-jekyll/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CloudCannon%2Fcloudcannon-jekyll/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264505738,"owners_count":23618965,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudcannon","cms","jekyll","jekyll-plugin","ssg","static-site-generator"],"created_at":"2025-02-17T22:16:37.158Z","updated_at":"2025-07-10T00:03:46.707Z","avatar_url":"https://github.com/CloudCannon.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CloudCannon Jekyll\n\nA Jekyll plugin that creates [CloudCannon](https://cloudcannon.com/) build information.\n\nThis plugin runs during your Jekyll build, discovering your pages, collections, and data files to\ncreate a JSON file used to automatically integrate the site with CloudCannon.\n\n[\u003cimg src=\"https://img.shields.io/gem/v/cloudcannon-jekyll?logo=rubygems\" alt=\"version badge\"\u003e](https://rubygems.org/gems/cloudcannon-jekyll)\n[\u003cimg src=\"https://img.shields.io/gem/dt/cloudcannon-jekyll\" alt=\"downloads badge\"\u003e](https://rubygems.org/gems/cloudcannon-jekyll)\n\n***\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n- [Development](#development)\n- [License](#license)\n\n***\n\n## Installation\n\n**You don't have to install anything** when building on CloudCannon. This plugin is automatically\ninstalled before your site is built. This gives you the latest support, new features, and fixes\nas they are released.\n\nAlthough **not recommended**, you can install the plugin manually.\n\n\u003cdetails\u003e\n\u003csummary\u003eManual installation steps\u003c/summary\u003e\n\n\u003cblockquote\u003e\n\nWhen installing manually, you'll have to upgrade when new versions are released.\nYou could also follow these steps to debug an integration issue locally. This assumes you are using [Bundler](https://bundler.io/) to manage dependencies.\n\nCloudCannon won't automatically install this plugin before builds if `cloudcannon-jekyll` is already installed.\n\n```sh\n$ bundle add cloudcannon-jekyll --group jekyll_plugins\n```\n\nAdd the following to your `_config.yml` if you're listing plugins here as well:\n\n```yaml\nplugins:\n  - cloudcannon-jekyll\n```\n\n💡 For Jekyll versions less than `v3.5.0`, use `gems` instead of `plugins`.\n\n\u003c/blockquote\u003e\n\u003c/details\u003e\n\n\n## Configuration\n\nThis plugin uses an optional configuration file as a base to generate `_cloudcannon/info.json`\n(used to integrate your site with CloudCannon).\n\nAdd your global CloudCannon configuration to this file, alongside any optional configuration for\nthis plugin.\n\nConfiguration files should be in the same directory you run `bundle exec jekyll build`. The first\nsupported file found in this order is used:\n\n- `cloudcannon.config.json`\n- `cloudcannon.config.yaml`\n- `cloudcannon.config.yml`\n\nAlternatively, use the `CLOUDCANNON_CONFIG_PATH` environment variable to use a specific config file\nin a custom location:\n\n```sh\n$ CLOUDCANNON_CONFIG_PATH=src/cloudcannon.config.yml bundle exec jekyll build\n```\n\nExample content for `cloudcannon.config.yml`:\n\n```yaml\n# Global CloudCannon configuration\n_inputs:\n  title:\n    type: text\n    comment: The title of your page.\n_select_data:\n  colors:\n    - Red\n    - Green\n    - Blue\n\n# Base path to your site source files, same as source for Jekyll\nsource: src\n\n# The subpath your built output files are mounted at, same as baseurl for Jekyll\nbase_url: /documentation\n\n# Populates collections for navigation and metadata in the editor\ncollections_config:\n  people:\n    # Base path for files in this collection, relative to source\n    path: content/people\n\n    # Whether this collection produces output files or not\n    output: true\n\n    # Collection-level configuration\n    name: Personnel\n    _enabled_editors:\n      - data\n  posts:\n    path: _posts\n    output: true\n  pages:\n    name: Main pages\n\n# Generates the data for select and multiselect inputs matching these names\ndata_config:\n  # Populates data with authors from an data file with the matching name\n  authors: true\n  offices: true\n\npaths:\n  # The default location for newly uploaded files, relative to source\n  uploads: assets/uploads\n\n  # The path to the root collections folder, relative to source\n  collections: items\n\n  # The path to site data files, relative to source\n  data: _data\n\n  # The path to site layout files, relative to source\n  layouts: _layouts\n\n  # The path to site include files, relative to source\n  includes: _partials\n```\n\nSee the [CloudCannon documentation](https://cloudcannon.com/documentation/) for more information\non the available features you can configure.\n\nConfiguration is set in `cloudcannon.config.*`, but the plugin also automatically\nreads and processes the following from Jekyll if unset:\n\n- `collections_config` from `collections` in `_config.yml`\n- `paths.collections` from `collections_dir` in `_config.yml`\n- `paths.layouts` from `layouts_dir` in `_config.yml`\n- `paths.data` from `data_dir` in `_config.yml`\n- `paths.includes` from `includes_dir` in `_config.yml`\n- `base_url` from `baseurl` in `_config.yml`\n- `source` from the `--source` CLI option or `source` in `_config.yml`\n\n## Development\n\n### Releasing new versions\n\n1. Increase the version in `lib/cloudcannon-jekyll/version.rb`\n2. Update `HISTORY.md`\n3. Commit and push those changes\n4. Run `./script/release`\n5. [Create a release on GitHub](https://github.com/CloudCannon/cloudcannon-jekyll/releases/new)\n\n### Testing\n\nRunning tests for currently installed Jekyll version:\n\n```sh\n$ ./script/test\n```\n\nRunning tests for all specified Jekyll versions:\n\n```sh\n$ ./script/test-all-versions\n```\n\nRunning tests for a specific Jekyll version:\n\n```sh\n$ JEKYLL_VERSION=\"2.4.0\" bundle update \u0026\u0026 ./script/test\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudcannon%2Fcloudcannon-jekyll","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudcannon%2Fcloudcannon-jekyll","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudcannon%2Fcloudcannon-jekyll/lists"}