alpha-one 0.3.2 → 0.3.3

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 +17 -4
  3. data/_includes/header.html +5 -2
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b8c1ba94cf60a8445656fe1d0fd0ac25e1dff2c4352126c9e933fa06fbf50910
4
- data.tar.gz: 7cb870e8a4bb9030ae0f450167a813d5f6d80966220d311b8f7913f6da6279a6
3
+ metadata.gz: 842a3027838f4cc83030e0942bb0e4db6888690cafe6276d9a1b46226b3c3607
4
+ data.tar.gz: 19debdf6603ff57f69aac2dd259688b4c432bb9d6f08b35908e8fe132dd5ad68
5
5
  SHA512:
6
- metadata.gz: ddc622c3b5f6b1d711ea555af0dd1a03330f2d65457fc30bcc8f9d6e85089d3ae3363cbdc778f6ca7df3677fae596c1422db9dcd9e7374db040c710578e50aa0
7
- data.tar.gz: e93ff3d91fdb41b9bb20cd028515e220c30428985e87ed14743cc8831bab9332e062cb6b1f90369a57fc66f33a40c43ca5f4f1ab728027b27c2680637cb2e46b
6
+ metadata.gz: dae271fa7eab6758e861ebc599d8e65d3def48d4f7244f4d970361276ed5110f3d7c847a93da73b67ce0fa553918b9dd0e816d4376f00317bddf76b7bc4ba369
7
+ data.tar.gz: e072c36d167f963f9be80d0abce189fabf1c20a0252bb30e398f62f1b155ce5472f66a4ce4c3f6f47865006cd301da0ef874ae2009256dae39cc54d344f5e052
data/README.md CHANGED
@@ -20,6 +20,11 @@ Alpha-One offers a `default` layout and a `post` layout. The `page` layout is a
20
20
 
21
21
  ## Installation
22
22
 
23
+ If not done already, init a new jekyll site:
24
+ ```
25
+ bundler exec jekyll new TODOO
26
+ ```
27
+
23
28
  Add this line to your Jekyll site's Gemfile:
24
29
 
25
30
  ```ruby
@@ -32,7 +37,9 @@ And add this line to your Jekyll site (_config.yml):
32
37
  theme: alpha-one
33
38
  ```
34
39
 
35
- And then execute:
40
+ Create a sample index.html page. You may want to copy the one from the demo-site to get you started quickly
41
+
42
+ Then execute:
36
43
 
37
44
  $ bundle
38
45
 
@@ -46,20 +53,26 @@ The following variable can/must be set in `_config.yml`:
46
53
  - title: text shown in the navbar and the footer
47
54
  - motto: a maxim shown in the footer, under the title
48
55
  - description: used by search engine
49
- - twitter_username
50
- - github_username
51
- - linkedin_username
56
+ - author (optional): used to add a meta author in the header
57
+ - twitter_username (optional)
58
+ - github_username (optional)
59
+ - linkedin_username (optional)
52
60
  - baseurl (optional): path to the root of your website; useful if it is hosted on a subpath
53
61
  - png_favicon: name of the png file to be used as favicon; must reside bellow $baseurl
54
62
  - header_link_1_label, header_link_1_href (both optional): used to add links in the navbar
55
63
 
56
64
 
65
+
57
66
  ## A note on table
58
67
 
59
68
  To prettify your tables, use kramdown and add
60
69
  `{: class="table table-striped"}`
61
70
  right bellow the table in the markdown file
62
71
 
72
+ ## About pagination
73
+
74
+ Pagination is not handled by the theme. See [Jekyll's doc page on pagination](https://jekyllrb.com/docs/pagination/)
75
+
63
76
  ## Contributing
64
77
 
65
78
  Bug reports and pull requests are welcome on [GitHub](https://github.com/proudier/alpha-one).
@@ -11,9 +11,12 @@
11
11
  {{ site.title }}
12
12
  {% endif %}
13
13
  </title>
14
- {% if site.description.size > 0 %}
14
+ {% if site.description.size > 0 %}
15
15
  <meta name="description" content="{{ site.description }}">
16
- {% endif %}
16
+ {% endif %}
17
+ {% if site.author.size > 0 %}
18
+ <meta name="author" content="{{ site.author }}">
19
+ {% endif %}
17
20
  <meta name="viewport" content="width=device-width, initial-scale=1">
18
21
 
19
22
  <!-- JS and CSS are fetch now to prevent FOUC -->
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.3.2
4
+ version: 0.3.3
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-03-02 00:00:00.000000000 Z
11
+ date: 2018-03-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll