black-white-blue 1.0.0 → 1.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: bb650430b4562d63b50319fd63066cde0a196439
4
- data.tar.gz: 44761b523eaee62e7ee8255c866c02714e255514
3
+ metadata.gz: 3e3ff0f4575beff83b152c61474319ea801286ea
4
+ data.tar.gz: c319d6d0b2f1252f1021f3facbf78ce82c4ebef5
5
5
  SHA512:
6
- metadata.gz: e477173ae093802182094a165bced27122e641199ec6a67ddc7771550495007b7c1e63bf58042cc45d06b1bf0cb87c76b094f25d313ab5d96e48d01e1834b877
7
- data.tar.gz: c3a4463ae48d51a97d66170f18cfbfe6c1f9d541b1d4c637d2fb920bdb65bf7ff06810acab88f57398f136d6f56b9bf239190c81d5078c0f8795fa4aaa049371
6
+ metadata.gz: bc1b1800cbbac9882d08ff403b52b88c92d1a07e550b541b4dee63ea87993e05e8aa87daa14334e0ae556e13631d0355a5b523193ae4e73fe0928d49ce516be6
7
+ data.tar.gz: aaac535b59e1588a6a3cdc73aaf5fba0ff841b0a49535d2b6231865f7be76987bcb330fb48ad2a5f3aa4ff333ea368bf9e38bdecd30be83704f98152ee687c0c
data/README.md CHANGED
@@ -3,25 +3,25 @@
3
3
  ![](https://travis-ci.org/crispgm/black-white-blue.svg)
4
4
  [![Gem Version](https://badge.fury.io/rb/black-white-blue.svg)](https://badge.fury.io/rb/black-white-blue)
5
5
 
6
- Black White Blue is a simple project page theme for Jekyll, which is designed to build project pages in a easier way.
6
+ Black White Blue is a simple and minimal project page theme for Jekyll, which is designed to build project pages in an easier way.
7
7
 
8
8
  Black, white and blue are the colors used in the page. White for background, black for text and blue for links.
9
9
 
10
10
  ## Installation
11
11
 
12
- Add this line to your Jekyll site's Gemfile:
12
+ Add to your Jekyll site's Gemfile:
13
13
 
14
14
  ```ruby
15
15
  gem "black-white-blue"
16
16
  ```
17
17
 
18
- And add this line to your Jekyll site:
18
+ And add this line to your `_config.yml`:
19
19
 
20
20
  ```yaml
21
21
  theme: black-white-blue
22
22
  ```
23
23
 
24
- And then execute:
24
+ Then execute:
25
25
 
26
26
  ```
27
27
  $ bundle install
@@ -31,7 +31,25 @@ $ bundle install
31
31
 
32
32
  ### Project Metadata
33
33
 
34
- Project metadata is defined in `_config.yml`.
34
+ Project metadata is defined in `_config.yml`:
35
+
36
+ ```yaml
37
+ project:
38
+ name: "Black White Blue"
39
+ subtitle: "A simple and minimal project page theme for Jekyll."
40
+ description: |-
41
+ Black White Blue is a simple project page theme for Jekyll, which is designed to build project pages in a easier way.
42
+ Black, white and blue are the colors used in the page. White for background, black for text and blue for links.
43
+ repo: "crispgm/black-white-blue"
44
+ logo: "/black-white-blue/assets/logo.png"
45
+ author: "David Zhang"
46
+ author_link: "https://crispgm.com/"
47
+ email: crispgm@gmail.com
48
+ twitter: crispgm
49
+ medium: "@crispgm"
50
+ ```
51
+
52
+ Email/Twitter/Medium is optional, which will be shown as icons on the bottom right.
35
53
 
36
54
  ### Changelog
37
55
 
@@ -39,7 +57,7 @@ Changelog is maintained in `_data/changelog.yml`.
39
57
 
40
58
  For a version, simply add an yaml array item:
41
59
 
42
- ```
60
+ ```yaml
43
61
  - version: "1.0.1"
44
62
  changes:
45
63
  - text: Performance improved
@@ -59,13 +77,28 @@ Each version comes with multiple changes, and you may present a text with an iss
59
77
 
60
78
  Edit `_config.yml` and set your `track_id`:
61
79
 
62
- ```
63
- google_analytics: xx-xxxxx
80
+ ```yaml
81
+ google_analytics: UA-XXXXXXXX-1
64
82
  ```
65
83
 
66
84
  ### Disqus
67
85
 
68
- * WIP
86
+ Init Disqus with your short name in `_config.yml`:
87
+
88
+ ```yaml
89
+ disqus:
90
+ shortname: your-short-name
91
+ ```
92
+
93
+ Then, enable Disqus in pages by adding frontmatter:
94
+
95
+ ```yaml
96
+ ---
97
+ layout: page
98
+ title: Disqus Example
99
+ comments: true
100
+ ---
101
+ ```
69
102
 
70
103
  # Contributing
71
104
 
@@ -1,4 +1,4 @@
1
- {% if page.comments != false and jekyll.environment == "production" %}
1
+ {% if page.comments == true and jekyll.environment == "production" %}
2
2
  <div id="disqus" class="content">
3
3
  <div id="disqus_thread"></div>
4
4
  <script>
data/_sass/section.scss CHANGED
@@ -16,6 +16,7 @@
16
16
  }
17
17
 
18
18
  .intro-logo {
19
+ margin: 3.2rem 0 0;
19
20
  text-align: center;
20
21
 
21
22
  img {
data/assets/logo.png ADDED
Binary file
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: black-white-blue
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Zhang
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-11-23 00:00:00.000000000 Z
11
+ date: 2017-11-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -90,6 +90,7 @@ files:
90
90
  - _sass/frame.scss
91
91
  - _sass/header.scss
92
92
  - _sass/section.scss
93
+ - assets/logo.png
93
94
  - assets/style.scss
94
95
  homepage: https://github.com/crispgm/black-white-blue
95
96
  licenses: