{"id":13612039,"url":"https://github.com/jamesluberda/github-pages-unscramble","last_synced_at":"2025-04-13T11:31:20.465Z","repository":{"id":56874341,"uuid":"147438265","full_name":"jamesluberda/github-pages-unscramble","owner":"jamesluberda","description":"github-pages-unscramble is a simple Jekyll plugin that undoes some runtime github-pages configuration changes","archived":false,"fork":false,"pushed_at":"2018-09-05T00:56:45.000Z","size":8,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-24T18:24:02.457Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/jamesluberda.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-05T00:48:04.000Z","updated_at":"2023-05-10T16:55:24.000Z","dependencies_parsed_at":"2022-08-20T22:30:38.946Z","dependency_job_id":null,"html_url":"https://github.com/jamesluberda/github-pages-unscramble","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesluberda%2Fgithub-pages-unscramble","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesluberda%2Fgithub-pages-unscramble/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesluberda%2Fgithub-pages-unscramble/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesluberda%2Fgithub-pages-unscramble/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jamesluberda","download_url":"https://codeload.github.com/jamesluberda/github-pages-unscramble/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248705607,"owners_count":21148561,"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":[],"created_at":"2024-08-01T20:00:21.482Z","updated_at":"2025-04-13T11:31:20.179Z","avatar_url":"https://github.com/jamesluberda.png","language":"Ruby","funding_links":[],"categories":["Settings \u0026 Configurations Tweaks"],"sub_categories":[],"readme":"# Github::Pages::Unscramble \n\n`github-pages-unscramble` is a simple Jekyll plugin that runs alongside the `github-pages` plugin to undo the changes that plugin makes to a site's original `plugin_dir` and `safe` configuration settings and load any file-based plugins in `plugins_dir`. It also loads any plugins specified in the site's `_config.yml` that would otherwise be ignored due to the `github-pages` whitelist filter.\n\nFor reference, the Jekyll `github-pages` gem reconfigures a Jekyll site at runtime, setting `plugins_dir` to a random string and `safe` to `true`, and as a result, local file-based plugins do not load. If you are not using `github-pages` or do not wish to run file-based plugins or non-whitelisted plugins, you do not need `github-pages-unscramble`.\n\nNote: `github-pages-unscramble` is intended to facilitate local plugin development and execution in a local GitHub Pages configured environment. It does not enable non-whitelisted plugins or file-based plugins to run directly on GitHub Pages.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'github-pages-unscramble', group: :jekyll-plugins\n```\n\nAnd then execute:\n\n```\n    $ bundle\n```\n\nNOTE: this gem must be included in the `jekyll-plugins` group to function.\n\n## Usage\n\nNo additional action is required by the user after installation. The plugin will automatically run upon site initialization, and will restore the site's original `plugin_dir` and `safe` settings and subsequently load any newly discovered file-based plugins. Note that these are runtime changes only, as with the `github-pages` gem, and no configuration changes are made persistent. Please note that because this plugin is simply restoring pre-`github-pages` settings, if your site is already hard configured with `safe` on, it will continue to retain that value, and no custom plugins will be loaded.\n\n## Debugging\n\n`github-pages-unscramble` will report on the actions it is taking if you add `--verbose` to the end of your `bundle exec jekyll` command.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/jamesluberda/github-pages-unscramble. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the Github::Pages::Unscramble project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jamesluberda/github-pages-unscramble/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamesluberda%2Fgithub-pages-unscramble","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjamesluberda%2Fgithub-pages-unscramble","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamesluberda%2Fgithub-pages-unscramble/lists"}