jekyll-bear-theme 0.1.1 → 0.1.2

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 +40 -5
  3. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1d3dac47362e4fdab38896ea44cdb9047fb1d447f64fe3f127910b44c5cc0460
4
- data.tar.gz: 6875fb95f7bbd55a043d252e4d047d178e1f0a905e6dc78e99c8ac324e6be920
3
+ metadata.gz: dcaf155719d4992615f39932269c807f31f819d1fa5d2f0f55b6bd73c428017b
4
+ data.tar.gz: 46722e478fe927d22ac1adfb9705e76155cc37f442e8740f8e66e0dc16499560
5
5
  SHA512:
6
- metadata.gz: 759c5f12c9ecbf97b3eadf2de2d020eadb275cef843773f1659856cac5417b8e790b7ce33905f3e3c500394f9d329f26057f5f89253dacbc031d4962a5c60a9c
7
- data.tar.gz: ba5ef0d70c9f23dafe0b1f1c6d63c8a7925c5d6bf07e4ba668ca42ce2794d9f62c45e413d4da6e6ff9707cb50eeab6a4894f03e99fde431e357bd9b778a0db50
6
+ metadata.gz: 06ad43b289b89a8337452fee3affbc6f360193d7d6f342562ef5b37db7e419a75c10b39a2fcb4be4e146dbbf25c190bd08b242924bf3215c3afdebe94b20dff9
7
+ data.tar.gz: a4533c4d7718070c53fccb075fb4e3e8ffdf1d3bfc59dd8721b31d414cfb2726660a461c9b24e062b6f850359067db87087d592668a622c8468110be5be25b3d
data/README.md CHANGED
@@ -23,13 +23,13 @@ This is a port of it's theme to Jekyll, with some tweaks. So you can use GitHub
23
23
  Add this line to your Jekyll site's `Gemfile`:
24
24
 
25
25
  ```ruby
26
- gem "jekyllBear"
26
+ gem "jekyll-bear-theme"
27
27
  ```
28
28
 
29
29
  And add this line to your Jekyll site's `_config.yml`:
30
30
 
31
31
  ```yaml
32
- theme: jekyllBear
32
+ theme: jekyll-bear-theme
33
33
  ```
34
34
 
35
35
  And then execute:
@@ -38,15 +38,50 @@ And then execute:
38
38
 
39
39
  Or install it yourself as:
40
40
 
41
- $ gem install jekyllBear
41
+ $ gem install jekyll-bear-theme
42
42
 
43
43
  ## Usage
44
44
 
45
- TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
45
+ Create a new repository for your website (if necessary)
46
+ ```jekyll
47
+ jekyll new my_website
48
+ ```
49
+
50
+ Copy over the following content from this repository, to serve as a base setup
51
+
52
+ ```
53
+ /posts -> Where you will write your posts
54
+ /_my_tags -> Where you will define your tags, if you need to add anything new
55
+ blog.md -> Homepage for your blog
56
+ index.md -> Website homepage
57
+ 404.html -> When a page is not available
58
+ ```
59
+
60
+ You will need to update `_config.yml`. Copy over the lines after
61
+
62
+ ```
63
+ #########################
64
+ # more settings
65
+ ```
66
+ in the `_config.yml` present in this repository to your website repository `_config.yml`.
67
+
68
+ Any new links you want to add to the navbar goes here, towards the end.
69
+ This also defines the bits about tags and filtering.
70
+
71
+ There should be 3 kinds of blog posts in the posts folder, an example of each type you can use:
72
+
73
+ - long-form reading
74
+ - poetry
75
+ - gallery view
76
+
77
+ Use them as templates for your front matter.
78
+
79
+ >To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
80
+
46
81
 
47
82
  ## Contributing
48
83
 
49
- 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.
84
+ Bug reports and pull requests are welcome on GitHub at https://github.com/knhash/jekyllBear. 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.
50
85
 
51
86
  ## Development
52
87
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-bear-theme
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - knhash