Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emilymclean/jekyll-detail-generator
A Jekyll generator to create pages for each element of a collection.
https://github.com/emilymclean/jekyll-detail-generator
jekyll jekyll-generator ruby
Last synced: 16 days ago
JSON representation
A Jekyll generator to create pages for each element of a collection.
- Host: GitHub
- URL: https://github.com/emilymclean/jekyll-detail-generator
- Owner: emilymclean
- License: mit
- Created: 2023-12-06T08:20:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-17T10:24:38.000Z (about 1 year ago)
- Last Synced: 2024-11-15T08:04:44.709Z (about 2 months ago)
- Topics: jekyll, jekyll-generator, ruby
- Language: Ruby
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Jekyll Detail Generator
A Jekyll generator to create pages for each element of a collection.
[](https://github.com/BenMMcLean/jekyll-detail-generator/actions/workflows/main.yml)
[](https://badge.fury.io/rb/jekyll-detail-generator)
## Installation
Install the gem and add to the application's Gemfile by executing:
$ bundle add jekyll-detail-generator
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install jekyll-detail-generator
## Usage
First, add the plugin to _config.yml:
```yaml
plugins:
- jekyll-detail-generator
```
Then, configure the generator so that it knows how to read your collection:
```yaml
detail_page_gen:
- collection: galleries
children_property: arts
layout: artdetail
title_property: title
url_property: identifier
```
In this case, the generator would look in the _galleries folder and scan through each file.
It would expect the elements of the collection to be under the property "arts", and for
each element to then contain a title and identifier property. Title will be used to title
the page, identifier will be used to generate a unique url in the form of "/filename/url_property".
Each generated page will use the layout artdetail.html, which is in turn passed each property of
the element under "item".
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
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 the created tag, 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/BenMMcLean/jekyll-detail-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/BenMMcLean/jekyll-detail-generator/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Jekyll::Detail::Generator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-detail-generator/blob/main/CODE_OF_CONDUCT.md).