Sha256: 6dee9c1ef64ffe9e85dbbf2db9478b4c7bafbafd05705f80de65fb31a2bddaa6
Contents?: true
Size: 1.98 KB
Versions: 8
Compression:
Stored size: 1.98 KB
Contents
# jekyll-bulma
jekyll-bulma is a gem based theme for Jekyll, and has been extracted out of
[jekyll octopod](https://jekyll-octopod.github.io/) and will be used there.
It is basically a Bulma theme, including the latest [Font Awesome](http://fontawesome.io/) 5.
## Preview
What's better than a screenshot?
<img alt="preview" src="screenshot.png" style="width: 60%;">
## Installation
Add this line to your Jekyll site's Gemfile:
```ruby
gem "jekyll-bulma"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: jekyll-bulma
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-bulma
## Usage
* Definitely visit the Bulma site, they have an
[awesome documentation](https://bulma.io/documentation/)
* Finally, also [Fontawesome](http://fontawesome.io/) have an awesome documentation.
We stick to their styles, so you won't find any additional documentation here.
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/jekyll-octopod/jekyll-bulma.
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](http://opensource.org/licenses/MIT).
Version data entries
8 entries across 8 versions & 1 rubygems