alpha-one 0.4.2 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -24
  3. data/_includes/header.html +9 -9
  4. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5d8b6d7be6bcdd7c4d65e153e5b06db93ef10415ea94bae584014a7f9c63d923
4
- data.tar.gz: 13caf937e2deca2e26e839782359cc5c64cd8f7e35d8b5dbc497cfbec0ab911a
3
+ metadata.gz: 6e9aa4690d1a4a6b82a77ad104d133862d2d59c180dde8af0ebd3759de4f02d5
4
+ data.tar.gz: a1151571b3cadc5a797726743d7c3fa371bf100cf9056575394dbbd87763c456
5
5
  SHA512:
6
- metadata.gz: ac678d1f689945c4b7a6aef3bb772bb93fb9654e163161c002a42f9f18cde01210ba502bea478e962db49e8cc70c52f0442349cecdf3635e4dac11d7ec8ea8d5
7
- data.tar.gz: d7e7519ee15e3608731469805caca89a30b9a1f503ca63cb539de245033f0bcadd266e0221adb0dc79246e504ffc1424463025b4f2b180424209801e79b3f95d
6
+ metadata.gz: 00ea7957d67ae4cff5c9c902d6f999ee8401709a79a6ca67d3097472a77222c5bcb88502d39e4dfb9dc018afea4f35a97ccb91f7db8eabb92353158e6e365555
7
+ data.tar.gz: 2fc36c486d3b70c60a7ceca26e353f0a224b55c50c10ebc4f8ab82aeb413fdf0cf5812f97bebeea307becc5c3bde122b2beafbf3d02498035f63a672077039f7
data/README.md CHANGED
@@ -4,50 +4,50 @@ A Jekyll theme designed for enhanced readability of (long) blog posts.
4
4
 
5
5
  ![alt text](preview.png "Alpha-One preview")
6
6
 
7
- ## Features
8
7
 
9
- - Responsive layout (based on Bootstrap)
10
- - Syntax highlighting
11
- - Social links (IN PROGRESS)
8
+
9
+ ## Features
10
+
11
+ - Responsive layout (based on Bootstrap 3)
12
+ - Social links
13
+ - Syntax highlighting with embedded pygments-css
12
14
  - Gem-based (ie. easy updates!)
13
15
 
14
- TODO:
16
+ ### Layouts
17
+
18
+ Alpha-One offers a `default` layout and a `post` layout. The `page` layout is a redirection to the `default` layout.
19
+
20
+ ### TODO
21
+
15
22
  - Tags listing page
16
23
  - Categories listing page
17
24
  - Google Analytics integration
18
25
 
19
- ### Layouts
20
-
21
- Alpha-One offers a `default` layout and a `post` layout. The `page` layout is a redirection to the `default` layout.
22
26
 
23
27
  ## Installation
24
28
 
25
- If not done already, init a new jekyll site:
26
- ```
27
- bundler exec jekyll new TODOO
28
- ```
29
-
30
- Add this line to your Jekyll site's Gemfile:
29
+ ### For experienced users
31
30
 
31
+ Add to Gemfile:
32
32
  ```ruby
33
33
  gem "alpha-one"
34
34
  ```
35
35
 
36
- And add this line to your Jekyll site (_config.yml):
37
-
36
+ Add to _config.yml __
38
37
  ```yaml
39
38
  theme: alpha-one
40
39
  ```
41
40
 
42
- Create a sample index.html page. You may want to copy the one from the demo-site to get you started quickly
41
+ See the configuration section bellow for mandatory and extra settings.
42
+ Create an index.html file; you may wish to copy the one from the demo site to get started quickly.
43
43
 
44
- Then execute:
44
+ ### For Jekyll newcomers
45
+
46
+ See how to install Jekyll [on the official website](https://jekyllrb.com/docs/installation/).
47
+ Follow the [quick start guide](https://jekyllrb.com/docs/quickstart/)
48
+ Now you should be ready to follow the abode 'For experienced users' section ;)
45
49
 
46
- $ bundle
47
50
 
48
- Maybe you will be interested in copying the following files from the sample website to your site:
49
- - favicon.png
50
- - posts.html
51
51
 
52
52
  ## Configuration
53
53
 
@@ -71,9 +71,11 @@ To prettify your tables, use kramdown and add
71
71
  `{: class="table table-striped"}`
72
72
  right bellow the table in the markdown file
73
73
 
74
+
75
+
74
76
  ## About pagination
75
77
 
76
- Pagination is not handled by the theme. See [Jekyll's doc page on pagination](https://jekyllrb.com/docs/pagination/)
78
+ Pagination is not handled by the theme. See [Jekyll's doc page on pagination](https://jekyllrb.com/docs/pagination/).
77
79
 
78
80
  ## Contributing
79
81
 
@@ -82,4 +84,3 @@ Bug reports and pull requests are welcome on [GitHub](https://github.com/proudie
82
84
  ## License
83
85
 
84
86
  The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
85
-
data/_includes/header.html CHANGED
@@ -4,15 +4,15 @@
4
4
 
5
5
  <head>
6
6
  <meta charset="utf-8">
7
- <title>
8
- {% if page.title.size > 0 %}
9
- {{ page.title }}
10
- {% else %}
11
- {{ site.title }}
12
- {% endif %}
13
- </title>
14
- {% if site.description.size > 0 %}
15
- <meta name="description" content="{{ site.description }}">
7
+ {% if page.title.size > 0 %}
8
+ <title>{{ page.title }}</title>
9
+ {% else %}
10
+ <title>{{ site.title }}</title>
11
+ {% endif %}
12
+ {% if page.excerpt.size > 0 %}
13
+ <meta name="description" content="{{ page.excerpt | remove: '<p>' | remove: '</p>' | strip_html | truncate: 160 | strip }}">
14
+ {% else %}
15
+ <meta name="description" content="{{ site.description | strip }}">
16
16
  {% endif %}
17
17
  {% if site.author.size > 0 %}
18
18
  <meta name="author" content="{{ site.author }}">
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: alpha-one
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.2
4
+ version: 0.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Pierre ROUDIER
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-05-25 00:00:00.000000000 Z
11
+ date: 2018-05-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
96
96
  version: '0'
97
97
  requirements: []
98
98
  rubyforge_project:
99
- rubygems_version: 2.7.6
99
+ rubygems_version: 2.7.7
100
100
  signing_key:
101
101
  specification_version: 4
102
102
  summary: A Jekyll theme designed for enhanced readability of (long) blog posts