Jekyll_pages_api

Overview

The Jekyll Pages API is a robust plugin gem designed for Jekyll - a static site generator that harnesses the power of Ruby. This gem effectively generates a JSON file consolidating data from all pages, posts, documents, and static files within a Jekyll site. For developers looking to streamline data integration and site functionality, this plugin presents an efficient solution by automating data generation whenever the site is rebuilt.

The versatility of the Jekyll Pages API extends beyond just generating JSON files; it can be utilized in various scenarios, including generating a searchable index for your site content. For developers familiar with Jekyll, this gem adds a layer of convenience and efficiency, enabling quick updates and easy access to site data.

Features

• Easy Setup: Simply add the gem to your application's Gemfile to start using it in your Jekyll project.

• Dynamic JSON Generation: Automatically generates a JSON file with your site’s pages, posts, documents, and static files whenever the site is rebuilt.

• Search Index Integration: Works seamlessly with the Jekyll Pages API Search plugin, allowing you to exclude certain documents from the search index by using the skip_index: true attribute.

• Standalone Functionality: Can be executed as a standalone tool to generate the pages.json file when using site generation tools other than Jekyll.

• Comprehensive Testing: Utilizes the AppraisalGem to ensure compatibility and pass tests across all supported versions of Jekyll.

• Flexible Development: Offers easy commands for building, testing, and managing versions during gem development.

• YAML Support: Capable of reading YAML front matter from source files, providing greater flexibility for content management.

• Additional Data Means: Offers options for integrating other Jekyll plugins and filters for transforming site content into useful data formats.