https://github.com/benbalter/jekyll-remote-theme
Jekyll plugin for building Jekyll sites with any GitHub-hosted theme
https://github.com/benbalter/jekyll-remote-theme
github-pages jekyll-plugin jekyll-site jekyll-themes
Last synced: about 1 year ago
JSON representation
Jekyll plugin for building Jekyll sites with any GitHub-hosted theme
- Host: GitHub
- URL: https://github.com/benbalter/jekyll-remote-theme
- Owner: benbalter
- License: mit
- Created: 2017-09-08T22:00:59.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-03T15:57:58.000Z (over 1 year ago)
- Last Synced: 2025-05-13T07:14:04.927Z (about 1 year ago)
- Topics: github-pages, jekyll-plugin, jekyll-site, jekyll-themes
- Language: Ruby
- Homepage:
- Size: 212 KB
- Stars: 300
- Watchers: 16
- Forks: 84
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
# Jekyll Remote Theme
Jekyll plugin for building Jekyll sites with any public GitHub-hosted theme
[](https://badge.fury.io/rb/jekyll-remote-theme) [](https://travis-ci.org/benbalter/jekyll-remote-theme) [](http://makeapullrequest.com)
## Usage
1. Add the following to your Gemfile
```ruby
gem "jekyll-remote-theme"
```
and run `bundle install` to install the plugin
2. Add the following to your site's `_config.yml` to activate the plugin
```yml
plugins:
- jekyll-remote-theme
```
Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
3. Add the following to your site's `_config.yml` to choose your theme
```yml
remote_theme: benbalter/retlab
```
or 1
```yml
remote_theme: http[s]://github..com/benbalter/retlab
```
1 The codeload subdomain needs to be available on your github enterprise instance for this to work.
## Declaring your theme
Remote themes are specified by the `remote_theme` key in the site's config.
For public GitHub, remote themes must be in the form of `OWNER/REPOSITORY`, and must represent a public GitHub-hosted Jekyll theme. See [the Jekyll documentation](https://jekyllrb.com/docs/themes/) for more information on authoring a theme. Note that you do not need to upload the gem to RubyGems or include a `.gemspec` file.
You may also optionally specify a branch, tag, or commit to use by appending an `@` and the Git ref (e.g., `benbalter/retlab@v1.0.0` or `benbalter/retlab@develop`). If you don't specify a Git ref, the `HEAD` ref will be used.
For Enterprise GitHub, remote themes must be in the form of `http[s]://GITHUBHOST.com/OWNER/REPOSITORY`, and must represent a public (non-private repository) GitHub-hosted Jekyll theme. Other than requiring the fully qualified domain name of the enterprise GitHub instance, this works exactly the same as the public usage.
## Debugging
Adding `--verbose` to the `build` or `serve` command may provide additional information.