jekyll-bulma 0.0.3 → 0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -4
  3. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: abe8088cfe4cefc8bf5cdc503d3e1371e0b2d8382541d4cf3dade5eb42cf4b37
4
- data.tar.gz: 38e1c5dbc5ebb3deddee6128b2b80b718b406365ae376611a6c72d5da1fe6e19
3
+ metadata.gz: 8c8aacf2025ae3d8907dfe1dd2d801c41ae8cdb5da190dff3e87b2e63adf2a9a
4
+ data.tar.gz: 8bde2386410c493ccc99bfa2fcedcde0a9f18f1c83def13d0fbd5d2dfd5b5486
5
5
  SHA512:
6
- metadata.gz: 6d85c21a3f4df4c437f730a61eec46eadfcab00beefbe3278e09e9e3d2cd461deaf2b415e603c764ce72254aa7beb22c3d53b6ce265d807456d1195be71d07e2
7
- data.tar.gz: 6ffc73f9228db512b3eba6120d179dfb27229973315fe23cfd66351fbdb7977433c1ce62c690fdcbd43cfefb7e883460a4363c3c7d0b47f2d352f6371f3f0ced
6
+ metadata.gz: c89a1e07651ea5066147a2030c52ecebf26714e60030bc4f5b9ae5acaea95a6688086ccbb7168289184912b88f63c34102f19fe2700ce1401a842c6bc43e49d5
7
+ data.tar.gz: f70650ea93363c949b290d530959ec8d47f785f6d2053f5224009cc2eebbd05d89b139bd850bb5ebbcd949e360037d37dec9dc0a4dc4d3016bdf3a4a5de9d903
data/README.md CHANGED
@@ -1,8 +1,19 @@
1
1
  # jekyll-bulma
2
2
 
3
+ jekyll-bulma is a gem based theme for Jekyll, and has been extracted out of
4
+ [jekyll octopod](https://jekyll-octopod.github.io/) and will be used there.
5
+
6
+ It is basically a Bulma theme, including the latest [Font Awesome](http://fontawesome.io/) 5.
7
+
8
+ ## Preview
9
+
10
+ What's better than a screenshot?
11
+
12
+ <img alt="preview" src="screenshot.png" style="width: 60%;">
13
+
3
14
  ## Installation
4
15
 
5
- Add this line to your Jekyll site's `Gemfile`:
16
+ Add this line to your Jekyll site's Gemfile:
6
17
 
7
18
  ```ruby
8
19
  gem "jekyll-bulma"
@@ -24,16 +35,34 @@ Or install it yourself as:
24
35
 
25
36
  ## Usage
26
37
 
27
- TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
38
+ * Definitely visit the Bulma site, they have an
39
+ [awesome documentation](https://bulma.io/documentation/)
40
+ * Finally, also [Fontawesome](http://fontawesome.io/) have an awesome documentation.
41
+
42
+ We stick to their styles, so you won't find any additional documentation here.
28
43
 
29
44
  ## Contributing
30
45
 
31
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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.
46
+ Bug reports and pull requests are welcome on GitHub at
47
+ https://github.com/jekyll-octopod/jekyll-bulma.
48
+ This project is intended to be a safe, welcoming space for collaboration,
49
+ and contributors are expected to adhere to the
50
+ [Contributor Covenant](http://contributor-covenant.org) code of conduct.
32
51
 
33
52
  ## Development
34
53
 
35
54
  To set up your environment to develop this theme, run `bundle install`.
36
55
 
56
+ Your theme is setup just like a normal Jekyll site! To test your theme, run
57
+ `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll
58
+ server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents.
59
+ As you make modifications to your theme and to your content, your site will regenerate and you
60
+ should see the changes in the browser after a refresh, just like normal.
61
+
62
+ When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with
63
+ Git will be released.
64
+
37
65
  ## License
38
66
 
39
- The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
67
+ The theme is available as open source under the terms of the
68
+ [MIT License](http://opensource.org/licenses/MIT).
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-bulma
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.3
4
+ version: '0.1'
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stefan Haslinger