tale 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 (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -6
  3. data/_sass/tale/_layout.scss +1 -0
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 2c38e370fa255314c26f68c4344b5d79b2ace1c7
4
- data.tar.gz: ce30140b274f68aea4fe1171630b22c3ad0125d6
3
+ metadata.gz: 343cdd488c3dee396bea05be636e0102cc2ea4ff
4
+ data.tar.gz: 5cb34e38f46ffa88d6b947f88aa264d44b1cc43e
5
5
  SHA512:
6
- metadata.gz: 467b9b035148b25eff6645d745c3b8b342a3a0884bcf7578987f1d17a1d015b55fee317cd6988904e3677b14800188f886e5d1d76ec60b758a7060a30e389c81
7
- data.tar.gz: f51b7076f79ad3ade8253139c0423960542dcdb481fa01e0f0c8d18c2cbbfd2ef27c02239be1e081fb6a6a25b75d52dd3733777026de5cc213e0535953a19f1c
6
+ metadata.gz: 86bd492e9d498295e23470a1377eda958e0e6b5b20efc6486edfc21656e69cfad8f340fc326e97a9dbdd953302ed0955098e28e741b245276e1487564c57335f
7
+ data.tar.gz: f7f354946a9a81635029d9e026dbf118a703abe4c8779d94370b7cc70a5f8a4d5d30435ab980511a99e4fb087109099c8993bccd9f80c5377cbb21c222a73093
data/README.md CHANGED
@@ -12,14 +12,14 @@ Tale is a minimal Jekyll theme curated for storytellers. Checkout the demo [here
12
12
  - Pagination of posts
13
13
 
14
14
  ## Installation
15
-
15
+ ### As a Jekyll theme
16
16
  1. Add this line to your `Gemfile`:
17
17
 
18
18
  ```ruby
19
19
  gem "tale"
20
20
  ```
21
21
 
22
- 2. And add this line to your `_config.yml`:
22
+ 2. In `_config.yml` replace the `minima` theme with `tale`:
23
23
 
24
24
  ```yaml
25
25
  theme: tale
@@ -27,13 +27,40 @@ theme: tale
27
27
 
28
28
  3. Install the theme's gems and dependencies:
29
29
 
30
- $ bundle
30
+ ```bash
31
+ $ bundle
32
+ ```
33
+
34
+ 4. Rename `index.md` to `index.html`. Without this, the `jekyll-paginate` gem will not work.
35
+
36
+ 5. Add these 2 lines in to `_config.yml`:
37
+
38
+ ```yaml
39
+ permalink: /:year-:month-:day/:title
40
+ paginate: 5
41
+ ```
42
+
43
+ ### As a Fork
44
+ 1. Fork this repository
31
45
 
32
- 4. Finally, build and serve your site
46
+ 2. Delete the unnecessary files/folders: `CODE_OF_CONDUCT.md`, `LICENSE`, `README.md`, `tale.gemspec`
33
47
 
34
- $ bundle exec jekyll serve
48
+ 3. Delete the `baseurl` line in `_config.yml`:
49
+
50
+ ```yaml
51
+ baseurl: "/tale" # delete this line
52
+ ```
53
+
54
+ ## Usage
55
+ Once you've installed the theme, you're ready to work on your Jekyll site. To start off, I would recommend updating `_config.yml` with your site's details.
56
+
57
+ To build and serve your site, run:
58
+
59
+ ```bash
60
+ $ bundle exec jekyll serve
61
+ ```
35
62
 
36
- Head to http://localhost:4000/tale/ to see your site in action.
63
+ And you're all set! Head over to http://127.0.0.1:4000/ to see your site in action.
37
64
 
38
65
  ## Contributing
39
66
  Found a bug or have a suggestion? Feel free to create an issue or make a pull request!
@@ -7,6 +7,7 @@
7
7
  main,
8
8
  footer,
9
9
  .nav-container {
10
+ display: block;
10
11
  margin: 0 auto;
11
12
  max-width: 800px;
12
13
  width: 80%;
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tale
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
  - Chester How
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-01-08 00:00:00.000000000 Z
11
+ date: 2018-01-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll