jekyll-theme-charcoal 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +93 -24
  3. data/_layouts/home.html +2 -2
  4. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: c5ed51c565f4f39e9ecb99631062096cbd09ce61
4
- data.tar.gz: 2e3eb4de0ccda78958a7ae39fc7a7fe9f4899e5d
3
+ metadata.gz: 6bbc714bc6342c9c47bc516e69d26084b9128e51
4
+ data.tar.gz: f9c80c4b19692a651f07e9839da1286aeb35733c
5
5
  SHA512:
6
- metadata.gz: 2cd17f110f805c6233c86d836a2355465f888128574ff02cd7842a5955c348760252f81b65ded057bc2584b26775bb3cd0d238b6c83263fd58d7758360238f07
7
- data.tar.gz: c4542e968d0bc84fd52b346e5675bf7b29bcf810ecc6af9cdb6e525202ab80eb33e75e28c09658edaaa1a735286b7d80c44002d341bebabad6d6d1bc9145ea0c
6
+ metadata.gz: ab11284a167f52060cdbebb9d121263ef9994edf38d65fe27a1fc91f8dd4cfed15ad390bb1841676ad0fec623034d4d9cc939082b93e9b680a5ae70214e41230
7
+ data.tar.gz: 39458a99e3bf972285bcc69ce1796829127c95f22f404c5ef683e524c11bfc5f1f3eeacedab26d70b086cc1b0e4e65361feaa5cc2cda7835d84b8902c4cad4e0
data/README.md CHANGED
@@ -1,13 +1,18 @@
1
+ ---
2
+ layout: home
3
+ title: Charcoal
4
+ permalink: /index.html
5
+ ---
1
6
  # Charcoal
2
7
 
3
- Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem.
4
- Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
8
+ A dark theme for [jekyll](https://jekyllrb.com/).
5
9
 
6
- To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
10
+ ## Usage
7
11
 
8
- TODO: Delete this and the text above, and describe your gem
12
+ The theme is available as open source under the terms of the [MIT License](LICENSE.txt).
13
+ It is distributed as a [ruby gem](https://rubygems.org/gems/jekyll-theme-charcoal).
9
14
 
10
- ## Installation
15
+ ### Installation
11
16
 
12
17
  Add this line to your Jekyll site's `Gemfile`:
13
18
 
@@ -15,42 +20,106 @@ Add this line to your Jekyll site's `Gemfile`:
15
20
  gem "jekyll-theme-charcoal"
16
21
  ```
17
22
 
18
- And add this line to your Jekyll site's `_config.yml`:
23
+ Add this line to your Jekyll site's `_config.yml`:
19
24
 
20
25
  ```yaml
21
26
  theme: jekyll-theme-charcoal
22
27
  ```
23
28
 
24
- And then execute:
29
+ And then run:
30
+
31
+ ```
32
+ user@localhost ~/my-awesome-site
33
+ $ bundle install
34
+ ```
25
35
 
26
- $ bundle
36
+ ### Layouts
27
37
 
28
- Or install it yourself as:
38
+ * `default` is the base layout, contianing only a header and content.
39
+ * `home` is ideal for a landing page, as it includes not only the content, but also a blog roll with RSS link and social links as configured below.
40
+ * `page` is currently no more than a repackaged default.
41
+ * `post` is currently no more than a repackaged default, except that [posts](https://jekyllrb.com/docs/posts/) are indexed and listed on the `home` page.
29
42
 
30
- $ gem install jekyll-theme-charcoal
43
+ In addition to the standard jekyll front matter, the charcoal theme can use `author_name` and `author_url` to add some background information about each page or post:
31
44
 
32
- ## Usage
45
+ ```yaml
46
+ author_name: Greg Gibeling
47
+ author_url: https://github.com/gdgib/
48
+ ```
33
49
 
34
- TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
50
+ ### Customization
51
+
52
+ You can configure a default author for pages and posts in your `_config.yml`:
53
+
54
+ ```
55
+ author_name: Greg Gibeling
56
+ author_url: https://github.com/gdgib/
57
+ ```
58
+
59
+ As [in minima](https://github.com/jekyll/minima/blob/master/README.md#social-networks) you can add links to the accounts you have on other sites, with respective icon, by adding one or more of the following options in your `_config.yml`:
60
+
61
+ ```
62
+ twitter_username: jekyllrb
63
+ github_username: jekyll
64
+ dribbble_username: jekyll
65
+ facebook_username: jekyll
66
+ flickr_username: jekyll
67
+ instagram_username: jekyll
68
+ linkedin_username: jekyll
69
+ pinterest_username: jekyll
70
+ youtube_username: jekyll
71
+ googleplus_username: +jekyll
72
+ rss: rss
73
+
74
+ mastodon:
75
+ - username: jekyll
76
+ instance: example.com
77
+ - username: jekyll2
78
+ instance: example.com
79
+ ```
35
80
 
36
81
  ## Contributing
37
82
 
38
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello.
39
- 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.
83
+ Issues and pull requests are welcome on [github.com/g2forge/charcoal](https://github.com/g2forge/charcoal).
40
84
 
41
85
  ## Development
42
86
 
43
- To set up your environment to develop this theme, run `bundle install`.
87
+ To set up your environment to develop this theme, run:
44
88
 
45
- Your theme is setup just like a normal Jekyll site!
46
- To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
47
- This starts a Jekyll server using your theme.
48
- Add pages, documents, data, etc. like normal to test your theme's contents.
49
- 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.
89
+ ```
90
+ user@localhost ~/charcoal
91
+ $ bundle install
92
+ ```
93
+
94
+ In order to test your changes locally you will
95
+ After that you can see your handiwork by viewing this page with any modifications you've made.
96
+ Please note that you will need to reload the page after changes as is normal with jekyll.
97
+
98
+ ```
99
+ user@localhost ~/charcoal
100
+ $ bundle exec jekyll serve
101
+ ```
50
102
 
51
- When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
52
- To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-charcoal.gemspec` accordingly.
103
+ ## Build
53
104
 
54
- ## License
105
+ To build the gem and install it for local development testing run:
55
106
 
56
- The theme is available as open source under the terms of the [MIT License](LICENSE.txt).
107
+ ```
108
+ user@localhost ~/charcoal
109
+ $ gem build ./jekyll-theme-charcoal.gemspec
110
+ $ gem install ./jekyll-theme-charcoal-<VERSION>.gem
111
+ ```
112
+
113
+ Once you are satisfied that this version is ready run:
114
+
115
+ ```
116
+ user@localhost ~/charcoal
117
+ $ gem push ./jekyll-theme-charcoal-<VERSION>.gem
118
+ ```
119
+
120
+ ## Inspiration
121
+
122
+ This theme is based on the following themes:
123
+
124
+ * [minima](https://github.com/jekyll/minima) by [Jekyll](https://jekyllrb.com/)
125
+ * [midnight](https://github.com/pages-themes/midnight) by [Matt Graham](https://twitter.com/michigangraham)
data/_layouts/home.html CHANGED
@@ -17,6 +17,6 @@ layout: default
17
17
  </li>
18
18
  {% endfor %}
19
19
  </ul>
20
- <h1>Social</h1>
21
- {% include social.html %}
22
20
  {% endif %}
21
+ <h1>Social</h1>
22
+ {% include social.html %}
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-charcoal
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Greg Gibeling
@@ -58,14 +58,14 @@ dependencies:
58
58
  requirements:
59
59
  - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: '10.0'
61
+ version: '12.0'
62
62
  type: :development
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: '10.0'
68
+ version: '12.0'
69
69
  description:
70
70
  email:
71
71
  - gdgib@outlook.com