Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mslinn/jekyll_run
Jekyll tag plugin that executes a program and returns the output from STDOUT.
https://github.com/mslinn/jekyll_run
jekyll jekyll-plugin
Last synced: 2 months ago
JSON representation
Jekyll tag plugin that executes a program and returns the output from STDOUT.
- Host: GitHub
- URL: https://github.com/mslinn/jekyll_run
- Owner: mslinn
- License: mit
- Created: 2022-03-16T19:42:41.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T19:25:37.000Z (5 months ago)
- Last Synced: 2024-10-15T19:22:22.359Z (3 months ago)
- Topics: jekyll, jekyll-plugin
- Language: Ruby
- Homepage: https://www.mslinn.com/jekyll_plugins/jekyll_run.html
- Size: 51.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# `jekyll_run` [](https://badge.fury.io/rb/jekyll_run)
`jekyll_run` Jekyll tag plugin that executes a program and returns the output from STDOUT.
Because the output includes the command that was executed,
and contains unselectable span tags,
this plugin is intended to be embedded within a pre tag.
## CSS
The following CSS must be used in order for the plugin to work:
```css
.unselectable {
color: #7922f9;
-moz-user-select: none;
-khtml-user-select: none;
user-select: none;
}
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'jekyll_run'
```
And then execute:
```shell
$ bundle
```
## Additional Information
More information is available on
[Mike Slinn’s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
## Development
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Install development dependencies like this:
```
$ BUNDLE_WITH="development" bundle
```
To build and install this gem onto your local machine, run:
```shell
$ bundle exec rake install
jekyll_run 1.0.0 built to pkg/jekyll_run-0.1.0.gem.
jekyll_run (1.0.0) installed.
$ gem info jekyll_run
*** LOCAL GEMS ***
jekyll_run (1.0.0)
Author: Mike Slinn
Homepage:
https://github.com/mslinn/jekyll_run
License: MIT
Installed at: /home/mslinn/.gems
Generates Jekyll logger with colored output.
```
To release a new version,
1. Update the version number in `version.rb`.
2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
3. Run the following:
```shell
$ bundle exec rake release
```
The above creates a git tag for the version, commits the created tag,
and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mslinn/jekyll_run.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).