Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/llorephie/jekyll-bootstrap
🎨 Bootstrap for Jekyll
https://github.com/llorephie/jekyll-bootstrap
bootstrap bootstrap-template bootstrap-theme bootstrap4 jekyll jekyll-template jekyll-theme
Last synced: 6 days ago
JSON representation
🎨 Bootstrap for Jekyll
- Host: GitHub
- URL: https://github.com/llorephie/jekyll-bootstrap
- Owner: llorephie
- License: mit
- Created: 2017-11-30T16:55:05.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-25T17:24:31.000Z (over 6 years ago)
- Last Synced: 2024-09-19T14:07:13.160Z (14 days ago)
- Topics: bootstrap, bootstrap-template, bootstrap-theme, bootstrap4, jekyll, jekyll-template, jekyll-theme
- Language: CSS
- Homepage: https://llorephie.github.io/jekyll-bootstrap/
- Size: 88.9 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# jekyll-bootstrap
Bootstrap theme gem for Jekyll. Complains latest W3C recomendations, if you not sure in this - feel free to create issue with your opinion.
### Versioning
This gem version will always point to latest version of Bootstrap + dot-separated version of theme files.
Example: 4.0.0-beta.2.1 should be read as "Bootstrap version 4.0.0-beta.2, theme version 1 for before mentioned Bootstrap version"
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-bootstrap"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: jekyll-bootstrap
```
or
```yaml
remote_theme: llorephie/jekyll-bootstrap
```
For use it on GitHub Pages.
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-bootstrap
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/llorephie/jekyll-bootstrap. 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.
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).