https://github.com/mslinn/jekyll_site_inspector

Dumps lots of information from site when enabled by the site_inspector setting in _config.yml.
https://github.com/mslinn/jekyll_site_inspector

jekyll jekyll-plugin

Last synced: 3 months ago
JSON representation

Dumps lots of information from site when enabled by the site_inspector setting in _config.yml.

• Host: GitHub
• URL: https://github.com/mslinn/jekyll_site_inspector
• Owner: mslinn
• License: mit
• Created: 2022-03-21T15:57:52.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-26T11:15:41.000Z (6 months ago)
• Last Synced: 2024-09-26T18:47:12.890Z (4 months ago)
• Topics: jekyll, jekyll-plugin
• Language: Ruby
• Homepage: https://www.mslinn.com/jekyll_plugins/jekyll_site_inspector.html
• Size: 35.2 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_site_inspector` [![Gem Version](https://badge.fury.io/rb/jekyll_site_inspector.svg)](https://badge.fury.io/rb/jekyll_site_inspector)

`jekyll_site_inspector` is a Jekyll tag plugin that displays lots of information from context for websites in development mode if `site_inspector: true` in `_config.yml`.

## Usage

```html

{% site_inspector %}

```


Output is also displayed on the console.

## Additional Information

More information is available on

[Mike Slinn’s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).

## Installation

Add this line to your application's Gemfile, within the `jekyll_plugins` group:

```ruby

group :jekyll_plugins do

  gem 'jekyll_site_inspector'

end

```

And then execute:

```shell

$ bundle

```

## 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.

### Build and Install Locally

To build and install this gem onto your local machine, run:

```shell

$ bundle exec rake install

jekyll_site_inspector 1.0.0 built to pkg/jekyll_site_inspector-0.1.0.gem.

jekyll_site_inspector (1.0.0) installed.

```

Examine the newly built gem:

```shell

$ gem info jekyll_site_inspector

*** LOCAL GEMS ***

jekyll_site_inspector (1.0.0)

    Author: Mike Slinn

    Homepage:

    https://github.com/mslinn/jekyll_site_inspector

    License: MIT

    Installed at: /home/mslinn/.gems

    Generates Jekyll logger with colored output.

```

### Build and Push to RubyGems

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

1. Fork the project

2. Create a descriptively named feature branch

3. Add your feature

4. Submit a pull request

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).