jekyll-simple-template 0.0.4 → 0.0.5
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 +5 -5
- data/README.md +132 -0
- data/_includes/footer.html +1 -1
- data/_includes/header.html +1 -1
- metadata +4 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 1f68570fff91f2efaedc0c342a6e1d5bb0ad0e6eb2c9ea5dff02abd04e3518d5
|
|
4
|
+
data.tar.gz: 4489bf6ca2aefe19f76fa572615c6162b434fc9ad10e983953cd2cf7355e7912
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 24efff0e53bf4d26023f4cbdb3102b21352f7ae33ae443185463d711283b9c6d9b1eaf5655b5d605b067a22a340b99b2fb87406735c51d7f007d218d77082af5
|
|
7
|
+
data.tar.gz: 90cec640b72c2d11e4ae892b291c598e5b961726ce7a23093c5bf182742231f64c0ebf03edbd77419b195d434d88e93e5629869716c82a7cfe988c098506427a
|
data/README.md
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# Simple Template - Jekyll
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/rb/jekyll-simple-template)
|
|
5
|
+
[](https://gitlab.com/simple-template/jekyll/pipelines)
|
|
7
|
+
[](https://travis-ci.org/simple-template/jekyll)
|
|
9
|
+
|
|
10
|
+
Demo: https://simple-template.gitlab.io/jekyll/
|
|
11
|
+
|
|
12
|
+
This is [Jekyll](https://jekyllrb.com/) Version of [Simple
|
|
13
|
+
Template](https://simple-template.gitlab.io/). The template is designed to look
|
|
14
|
+
and stay minimal for the viewer but at the same time be fully featured for the
|
|
15
|
+
author. The template use the fact that barebone *HTML* is already responsive,
|
|
16
|
+
and hence, no *CSS* Framework is used at all. In fact for styling there is not
|
|
17
|
+
even a *CSS* file, the necesarry *CSS* is embedded into *HTML* itself, to
|
|
18
|
+
reduce the number of *HTTP* requests.
|
|
19
|
+
|
|
20
|
+
## Plugins
|
|
21
|
+
|
|
22
|
+
Instead of inventing the wheel, I used the following popular plugins for Jekyll,
|
|
23
|
+
to add features to the template:
|
|
24
|
+
|
|
25
|
+
* [jekyll-archives](https://github.com/jekyll/jekyll-archives): Generates
|
|
26
|
+
Archive pages for Year, Month, Day, Tags and Categories
|
|
27
|
+
* [jekyll-feed](https://github.com/jekyll/jekyll-feed): Generates the Atom (RSS
|
|
28
|
+
like) Feed for Blog Posts
|
|
29
|
+
* [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag): Adds necesarry
|
|
30
|
+
SEO information in the head tag
|
|
31
|
+
* [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap): Generates
|
|
32
|
+
sitemap.org compliant sitemap for the website
|
|
33
|
+
|
|
34
|
+
## Usage
|
|
35
|
+
|
|
36
|
+
The template is available as Ruby
|
|
37
|
+
[Gem](https://rubygems.org/gems/jekyll-simple-template/). To add the Gem to the
|
|
38
|
+
website do the following:
|
|
39
|
+
|
|
40
|
+
* Add the Gem in the `Gemfile`.
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
source "https://rubygems.org"
|
|
44
|
+
"jekyll-simple-template"
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
* Add the Theme in `_config.yml`.
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
theme: jekyll-simple-template
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Configuration
|
|
54
|
+
|
|
55
|
+
The template excepts following variables in the `_config.yml`.
|
|
56
|
+
|
|
57
|
+
* `lang`: Langauge of the Website (for html tag)
|
|
58
|
+
* `title`: Title of the Website (for SEO and Header)
|
|
59
|
+
* `author`: Author of the Website (for SEO and Footer)
|
|
60
|
+
* `url`: Url of the website (for SEO)
|
|
61
|
+
* `baseurl` [Optional]: Baseurl of the Website (for relative URL)
|
|
62
|
+
* `logo`: Logo of the Website (for SEO)
|
|
63
|
+
|
|
64
|
+
[Example](https://github.com/simple-template/jekyll/blob/master/_config.yml)
|
|
65
|
+
|
|
66
|
+
### Navigation
|
|
67
|
+
|
|
68
|
+
For navigation links, the template looks for `_data/navigation.yml` file. The
|
|
69
|
+
links should be added to the file in following format.
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
- title: "Link Name"
|
|
73
|
+
url: "http://example.com"
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
**Note**: `url` can be external or relative.
|
|
77
|
+
|
|
78
|
+
[Example](https://github.com/simple-template/jekyll/blob/master/_data/navigation.yml)
|
|
79
|
+
|
|
80
|
+
### Social Links
|
|
81
|
+
|
|
82
|
+
For social links in footer, the template looks for `_data/social.yml` file.
|
|
83
|
+
Following is the supported social networks and format in which it should be
|
|
84
|
+
added.
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
facebook : username
|
|
88
|
+
twitter : username
|
|
89
|
+
github : username
|
|
90
|
+
youtube : channel
|
|
91
|
+
instagram: username
|
|
92
|
+
linkedin : username
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
[Example](https://github.com/simple-template/jekyll/blob/master/_data/social.yml)
|
|
96
|
+
|
|
97
|
+
### SEO
|
|
98
|
+
|
|
99
|
+
As mentioned above, the template uses
|
|
100
|
+
[jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag/) for adding SEO
|
|
101
|
+
information. All the options from that can be used. For more information read
|
|
102
|
+
its [Usage](https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md).
|
|
103
|
+
|
|
104
|
+
## Sitemap and Feed
|
|
105
|
+
|
|
106
|
+
As mentioned above, the template uses
|
|
107
|
+
[jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap/) and
|
|
108
|
+
[jekyll-feed](https://github.com/jekyll/jekyll-feed) for sitemap and feed
|
|
109
|
+
respectively. By default sitemap is available at `/sitemap.xml` and feed of
|
|
110
|
+
posts is available at `/feed.xml`. For more information about the plugins, check
|
|
111
|
+
out there repositories and read the documentations.
|
|
112
|
+
|
|
113
|
+
## Layouts
|
|
114
|
+
|
|
115
|
+
The template provides following layouts:
|
|
116
|
+
|
|
117
|
+
* `default`: The default layout
|
|
118
|
+
* `home`: For Homepage
|
|
119
|
+
* `blog`: For Blog page
|
|
120
|
+
* `page`: For Page
|
|
121
|
+
* `post`: For post
|
|
122
|
+
* `archive`: For Year, Month, Day and Tag archives
|
|
123
|
+
* `redirect`: For redirection pages
|
|
124
|
+
|
|
125
|
+
To override any of the built-in layouts, just create the file with same name in
|
|
126
|
+
`_layouts/` directory.
|
|
127
|
+
|
|
128
|
+
## License
|
|
129
|
+
|
|
130
|
+
The template is Open Sourced and is Licensed under [BSD
|
|
131
|
+
3-Clause](https://github.com/simple-template/jekyll/blob/master/LICENSE)
|
|
132
|
+
License.
|
data/_includes/footer.html
CHANGED
data/_includes/header.html
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-simple-template
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ankit R Gadiya
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-
|
|
11
|
+
date: 2018-04-01 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -102,6 +102,7 @@ extensions: []
|
|
|
102
102
|
extra_rdoc_files: []
|
|
103
103
|
files:
|
|
104
104
|
- LICENSE
|
|
105
|
+
- README.md
|
|
105
106
|
- _includes/footer.html
|
|
106
107
|
- _includes/head.html
|
|
107
108
|
- _includes/header.html
|
|
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
134
135
|
version: '0'
|
|
135
136
|
requirements: []
|
|
136
137
|
rubyforge_project:
|
|
137
|
-
rubygems_version: 2.
|
|
138
|
+
rubygems_version: 2.7.6
|
|
138
139
|
signing_key:
|
|
139
140
|
specification_version: 4
|
|
140
141
|
summary: A very simple and minimal but fully functional template
|