jekyll-readthedocs 0.2.3 → 0.2.4
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 +4 -4
- data/README.md +31 -1
- data/_includes/head.html +1 -1
- data/_includes/sidebar.html +32 -32
- data/_includes/social.html +11 -10
- data/_layouts/home.html +12 -9
- data/_sass/minima/_base.scss +9 -0
- data/_sass/minima/_layout.scss +17 -6
- data/assets/minima-social-icons.svg +6 -0
- metadata +20 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a02b6820185c1f434aa40d443fe9b952777b0d7d
|
|
4
|
+
data.tar.gz: 3c8aa7815dadf6a7d6f3337ca31831841e07f8c0
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e171a1346237106b27dfaf0cb58555dda8c1aeea17d0076fd4b86f6a5bfae4c9ddabf85161fa1b76f27805398fbd5939f11b5c385987713004fb57069de28ea4
|
|
7
|
+
data.tar.gz: 79cdf3bd16f36ab7c2a6ea3a930ca4aa10979fffc38e2d1775ca3681314b41801d9a8dab61cca18c7ebc9262f55d859f2aa7f06c6e8da4c7a231bce439b1c2bd
|
data/README.md
CHANGED
|
@@ -99,7 +99,7 @@ It will be automatically included only when your site contains one or more valid
|
|
|
99
99
|
|
|
100
100
|
The title for this section is `Posts` by default and rendered with an `<h2>` tag. You can customize this heading by defining a `list_title` variable in the document's front matter.
|
|
101
101
|
|
|
102
|
-
To add post excerpts in the post listing, set `
|
|
102
|
+
To add post excerpts in the post listing, set `show_excerpt: true` in `_config.yml`.
|
|
103
103
|
|
|
104
104
|
--
|
|
105
105
|
|
|
@@ -124,6 +124,20 @@ The site's default CSS has now moved to a new place within the gem itself, [`ass
|
|
|
124
124
|
|
|
125
125
|
--
|
|
126
126
|
|
|
127
|
+
### Customize navigation links
|
|
128
|
+
|
|
129
|
+
This allows you to set which pages you want to appear in the navigation area and configure order of the links.
|
|
130
|
+
|
|
131
|
+
For instance, to only link to the `about` and the `portfolio` page, add the following to you `_config.yml`:
|
|
132
|
+
|
|
133
|
+
```yaml
|
|
134
|
+
header_pages:
|
|
135
|
+
- about.md
|
|
136
|
+
- portfolio.md
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
--
|
|
140
|
+
|
|
127
141
|
### Change default date format
|
|
128
142
|
|
|
129
143
|
You can change the default date format by specifying `site.minima.date_format`
|
|
@@ -173,6 +187,12 @@ pinterest_username: jekyll
|
|
|
173
187
|
youtube_username: jekyll
|
|
174
188
|
googleplus_username: +jekyll
|
|
175
189
|
rss: rss
|
|
190
|
+
|
|
191
|
+
mastodon:
|
|
192
|
+
- username: jekyll
|
|
193
|
+
instance: example.com
|
|
194
|
+
- username: jekyll2
|
|
195
|
+
instance: example.com
|
|
176
196
|
```
|
|
177
197
|
|
|
178
198
|
--
|
|
@@ -187,6 +207,16 @@ To enable Google Anaytics, add the following lines to your Jekyll site:
|
|
|
187
207
|
|
|
188
208
|
Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
|
|
189
209
|
|
|
210
|
+
--
|
|
211
|
+
|
|
212
|
+
### Enabling Excerpts on the Home Page
|
|
213
|
+
|
|
214
|
+
To display post-excerpts on the Home Page, simply add the following to your `_config.yml`:
|
|
215
|
+
|
|
216
|
+
```yaml
|
|
217
|
+
show_excerpts: true
|
|
218
|
+
```
|
|
219
|
+
|
|
190
220
|
## Contributing
|
|
191
221
|
|
|
192
222
|
Bug reports and pull requests are welcome on GitHub at https://github.com/Pawamoy/jekyll-readthedocs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
data/_includes/head.html
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
5
5
|
{% seo %}
|
|
6
6
|
<link rel="stylesheet" href="{{ "/assets/main.css" | relative_url }}">
|
|
7
|
-
|
|
7
|
+
{% feed_meta %}
|
|
8
8
|
{% if jekyll.environment == 'production' and site.google_analytics %}
|
|
9
9
|
{% include google-analytics.html %}
|
|
10
10
|
{% endif %}
|
data/_includes/sidebar.html
CHANGED
|
@@ -7,40 +7,40 @@
|
|
|
7
7
|
|
|
8
8
|
{% assign default_paths = site.pages | map: "path" %}
|
|
9
9
|
{% assign page_paths = site.header_pages | default: default_paths %}
|
|
10
|
-
{% if page_paths %}
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
10
|
+
<!-- {% if page_paths %} -->
|
|
11
|
+
<nav class="site-nav">
|
|
12
|
+
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
|
13
|
+
<label for="nav-trigger">
|
|
14
|
+
<span class="menu-icon">
|
|
15
|
+
<svg viewBox="0 0 18 15" width="18px" height="15px">
|
|
16
|
+
<path fill="#424242" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"/>
|
|
17
|
+
<path fill="#424242" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484 h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"/>
|
|
18
|
+
<path fill="#424242" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"/>
|
|
19
|
+
</svg>
|
|
20
|
+
</span>
|
|
21
|
+
</label>
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
{% endfor %}
|
|
30
|
-
</ul>
|
|
31
|
-
<!-- </nav> -->
|
|
32
|
-
{% endif %}
|
|
33
|
-
|
|
34
|
-
{% if site.posts.size > 0 %}
|
|
35
|
-
<ul>
|
|
36
|
-
{% for post in site.posts %}
|
|
37
|
-
<li {% if page.title == post.title %}class="active"{% endif %}>
|
|
38
|
-
{% assign date_format = site.minima.date_format | default: "%b %-d, %Y" %}
|
|
39
|
-
<span>{{ post.date | date: date_format }}</span><br>
|
|
40
|
-
<a href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
|
|
41
|
-
</li>
|
|
23
|
+
<ul class="trigger">
|
|
24
|
+
{% for path in page_paths %}
|
|
25
|
+
{% assign my_page = site.pages | where: "path", path | first %}
|
|
26
|
+
{% if my_page.title %}
|
|
27
|
+
<li class="{% if page.title == my_page.title %}active{% endif %}"><a href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a></li>
|
|
28
|
+
{% endif %}
|
|
42
29
|
{% endfor %}
|
|
43
30
|
</ul>
|
|
44
|
-
{% endif %}
|
|
31
|
+
<!-- {% endif %} -->
|
|
32
|
+
|
|
33
|
+
{% if site.posts.size > 0 %}
|
|
34
|
+
<ul class="trigger">
|
|
35
|
+
{% for post in site.posts %}
|
|
36
|
+
<li class="{% if page.title == post.title %}active{% endif %}">
|
|
37
|
+
{% assign date_format = site.minima.date_format | default: "%b %-d, %Y" %}
|
|
38
|
+
<span>{{ post.date | date: date_format }}</span><br>
|
|
39
|
+
<a href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
|
|
40
|
+
</li>
|
|
41
|
+
{% endfor %}
|
|
42
|
+
</ul>
|
|
43
|
+
{% endif %}
|
|
44
|
+
</nav>
|
|
45
45
|
|
|
46
46
|
</div>
|
data/_includes/social.html
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
<ul class="social-media-list">
|
|
2
|
-
{% if site.
|
|
3
|
-
{% if site.
|
|
4
|
-
{% if site.
|
|
5
|
-
{% if site.
|
|
6
|
-
{% if site.
|
|
7
|
-
{% if site.
|
|
8
|
-
{% if site.
|
|
9
|
-
{%
|
|
10
|
-
{% if site.
|
|
11
|
-
{% if site.
|
|
2
|
+
{% if site.dribbble_username%}<li><a href="https://dribbble.com/{{ site.dribbble_username| cgi_escape | escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#dribbble"></use></svg> <span class="username">{{ site.dribbble_username| escape }}</span></a></li>{% endif %}
|
|
3
|
+
{% if site.facebook_username%}<li><a href="https://www.facebook.com/{{ site.facebook_username| cgi_escape | escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#facebook"></use></svg> <span class="username">{{ site.facebook_username| escape }}</span></a></li>{% endif %}
|
|
4
|
+
{% if site.flickr_username%}<li><a href="https://www.flickr.com/photos/{{ site.flickr_username| cgi_escape | escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#flickr"></use></svg> <span class="username">{{ site.flickr_username| escape }}</span></a></li>{% endif %}
|
|
5
|
+
{% if site.github_username%}<li><a href="https://github.com/{{ site.github_username| cgi_escape | escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#github"></use></svg> <span class="username">{{ site.github_username| escape }}</span></a></li>{% endif %}
|
|
6
|
+
{% if site.instagram_username%}<li><a href="https://instagram.com/{{ site.instagram_username| cgi_escape | escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#instagram"></use></svg> <span class="username">{{ site.instagram_username| escape }}</span></a></li>{% endif %}
|
|
7
|
+
{% if site.linkedin_username%}<li><a href="https://www.linkedin.com/in/{{ site.linkedin_username| cgi_escape | escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#linkedin"></use></svg> <span class="username">{{ site.linkedin_username| escape }}</span></a></li>{% endif %}
|
|
8
|
+
{% if site.pinterest_username%}<li><a href="https://www.pinterest.com/{{ site.pinterest_username| cgi_escape | escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#pinterest"></use></svg> <span class="username">{{ site.pinterest_username| escape }}</span></a></li>{% endif %}
|
|
9
|
+
{% for mst in site.mastodon %}{% if mst.username and mst.instance %}<li><a href="https://{{ mst.instance| cgi_escape | escape}}/@{{mst.username}}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#mastodon"></use></svg> <span class="username">{{ mst.username|escape }}</span></a></li>{% endif %}{% endfor %}
|
|
10
|
+
{% if site.twitter_username%}<li><a href="https://www.twitter.com/{{ site.twitter_username| cgi_escape | escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#twitter"></use></svg> <span class="username">{{ site.twitter_username| escape }}</span></a></li>{% endif %}
|
|
11
|
+
{% if site.youtube_username%}<li><a href="https://youtube.com/{{ site.youtube_username| cgi_escape | escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#youtube"></use></svg> <span class="username">{{ site.youtube_username| escape }}</span></a></li>{% endif %}
|
|
12
|
+
{% if site.googleplus_username%}<li><a href="https://plus.google.com/{{ site.googleplus_username| escape }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#googleplus"></use></svg> <span class="username">{{ site.googleplus_username| escape }}</span></a></li>{% endif %}
|
|
12
13
|
{% if site.rss %}<li><a href="{{ 'feed.xml' | relative_url }}"><svg class="svg-icon"><use xlink:href="/assets/minima-social-icons.svg#rss"></use></svg> <span>{{ site.rss | escape }}</span></a></li>{% endif %}
|
|
13
14
|
</ul>
|
data/_layouts/home.html
CHANGED
|
@@ -13,15 +13,18 @@ layout: default
|
|
|
13
13
|
<h2 class="post-list-heading">{{ page.list_title | default: "" }}</h2>
|
|
14
14
|
<ul class="post-list">
|
|
15
15
|
{% for post in site.posts %}
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
<
|
|
21
|
-
|
|
22
|
-
</
|
|
23
|
-
|
|
24
|
-
|
|
16
|
+
<li>
|
|
17
|
+
{% assign date_format = site.minima.date_format | default: "%b %-d, %Y" %}
|
|
18
|
+
<span class="post-meta">{{ post.date | date: date_format }}</span>
|
|
19
|
+
<h3>
|
|
20
|
+
<a class="post-link" href="{{ post.url | relative_url }}">
|
|
21
|
+
{{ post.title | escape }}
|
|
22
|
+
</a>
|
|
23
|
+
</h3>
|
|
24
|
+
{% if site.show_excerpts %}
|
|
25
|
+
{{ post.excerpt }}
|
|
26
|
+
{% endif %}
|
|
27
|
+
</li>
|
|
25
28
|
{% endfor %}
|
|
26
29
|
</ul>
|
|
27
30
|
|
data/_sass/minima/_base.scss
CHANGED
data/_sass/minima/_layout.scss
CHANGED
|
@@ -51,10 +51,10 @@
|
|
|
51
51
|
@include media-query($on-palm) {
|
|
52
52
|
position: absolute;
|
|
53
53
|
top: 9px;
|
|
54
|
-
right:
|
|
55
|
-
background-color:
|
|
56
|
-
border: 1px solid $grey-color-light;
|
|
57
|
-
border-radius: 5px;
|
|
54
|
+
right: 0;
|
|
55
|
+
background-color: #171A2F;
|
|
56
|
+
// border: 1px solid $grey-color-light;
|
|
57
|
+
// border-radius: 5px;
|
|
58
58
|
text-align: right;
|
|
59
59
|
|
|
60
60
|
label[for="nav-trigger"] {
|
|
@@ -274,8 +274,13 @@
|
|
|
274
274
|
* Sidebar
|
|
275
275
|
*/
|
|
276
276
|
.main-wrapper {
|
|
277
|
-
|
|
277
|
+
|
|
278
278
|
margin-left: 300px;
|
|
279
|
+
|
|
280
|
+
@include media-query($on-palm) {
|
|
281
|
+
margin-left: 0;
|
|
282
|
+
margin-top: 80px;
|
|
283
|
+
}
|
|
279
284
|
}
|
|
280
285
|
|
|
281
286
|
.site-sidebar {
|
|
@@ -283,9 +288,15 @@
|
|
|
283
288
|
height: 100%;
|
|
284
289
|
width: 300px;
|
|
285
290
|
position: fixed;
|
|
286
|
-
// float: left;
|
|
287
291
|
background-color: #171A2F;
|
|
288
292
|
|
|
293
|
+
@include media-query($on-palm) {
|
|
294
|
+
height: 50px;
|
|
295
|
+
width: 100%;
|
|
296
|
+
position: absolute;
|
|
297
|
+
top: 0;
|
|
298
|
+
}
|
|
299
|
+
|
|
289
300
|
.sidebar-title {
|
|
290
301
|
display: block;
|
|
291
302
|
font-size: 100%;
|
|
@@ -24,4 +24,10 @@
|
|
|
24
24
|
|
|
25
25
|
<symbol id="youtube" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414"><path d="M0 7.345c0-1.294.16-2.59.16-2.59s.156-1.1.636-1.587c.608-.637 1.408-.617 1.764-.684C3.84 2.36 8 2.324 8 2.324s3.362.004 5.6.166c.314.038.996.04 1.604.678.48.486.636 1.588.636 1.588S16 6.05 16 7.346v1.258c0 1.296-.16 2.59-.16 2.59s-.156 1.102-.636 1.588c-.608.638-1.29.64-1.604.678-2.238.162-5.6.166-5.6.166s-4.16-.037-5.44-.16c-.356-.067-1.156-.047-1.764-.684-.48-.487-.636-1.587-.636-1.587S0 9.9 0 8.605v-1.26zm6.348 2.73V5.58l4.323 2.255-4.32 2.24z"/></symbol>
|
|
26
26
|
|
|
27
|
+
<symbol id="mastodon" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414">
|
|
28
|
+
<path transform="scale(0.07)" d="M211.80734 139.0875c-3.18125 16.36625-28.4925 34.2775-57.5625 37.74875-15.15875 1.80875-30.08375 3.47125-45.99875 2.74125-26.0275-1.1925-46.565-6.2125-46.565-6.2125 0 2.53375.15625 4.94625.46875 7.2025 3.38375 25.68625 25.47 27.225 46.39125 27.9425 21.11625.7225 39.91875-5.20625 39.91875-5.20625l.8675 19.09s-14.77 7.93125-41.08125 9.39c-14.50875.7975-32.52375-.365-53.50625-5.91875C9.23234 213.82 1.40609 165.31125.20859 116.09125c-.365-14.61375-.14-28.39375-.14-39.91875 0-50.33 32.97625-65.0825 32.97625-65.0825C49.67234 3.45375 78.20359.2425 107.86484 0h.72875c29.66125.2425 58.21125 3.45375 74.8375 11.09 0 0 32.975 14.7525 32.975 65.0825 0 0 .41375 37.13375-4.59875 62.915"/>
|
|
29
|
+
<path transform="scale(0.07)" fill="#FFF" d="M177.50984 80.077v60.94125h-24.14375v-59.15c0-12.46875-5.24625-18.7975-15.74-18.7975-11.6025 0-17.4175 7.5075-17.4175 22.3525v32.37625H96.20734V85.42325c0-14.845-5.81625-22.3525-17.41875-22.3525-10.49375 0-15.74 6.32875-15.74 18.7975v59.15H38.90484V80.077c0-12.455 3.17125-22.3525 9.54125-29.675 6.56875-7.3225 15.17125-11.07625 25.85-11.07625 12.355 0 21.71125 4.74875 27.8975 14.2475l6.01375 10.08125 6.015-10.08125c6.185-9.49875 15.54125-14.2475 27.8975-14.2475 10.6775 0 19.28 3.75375 25.85 11.07625 6.36875 7.3225 9.54 17.22 9.54 29.675"/>
|
|
30
|
+
</symbol>
|
|
31
|
+
|
|
32
|
+
|
|
27
33
|
</svg>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-readthedocs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.
|
|
4
|
+
version: 0.2.4
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Timothée Mazzucotelli
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-02-
|
|
11
|
+
date: 2018-02-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -24,6 +24,20 @@ dependencies:
|
|
|
24
24
|
- - "~>"
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
26
|
version: '3.5'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: jekyll-feed
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '0.9'
|
|
34
|
+
type: :runtime
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - "~>"
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '0.9'
|
|
27
41
|
- !ruby/object:Gem::Dependency
|
|
28
42
|
name: jekyll-seo-tag
|
|
29
43
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -44,14 +58,14 @@ dependencies:
|
|
|
44
58
|
requirements:
|
|
45
59
|
- - "~>"
|
|
46
60
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: '1.
|
|
61
|
+
version: '1.15'
|
|
48
62
|
type: :development
|
|
49
63
|
prerelease: false
|
|
50
64
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
65
|
requirements:
|
|
52
66
|
- - "~>"
|
|
53
67
|
- !ruby/object:Gem::Version
|
|
54
|
-
version: '1.
|
|
68
|
+
version: '1.15'
|
|
55
69
|
description:
|
|
56
70
|
email:
|
|
57
71
|
- timothee.mazzucotelli@gmail.com
|
|
@@ -84,7 +98,8 @@ files:
|
|
|
84
98
|
homepage: https://github.com/Pawamoy/jekyll-readthedocs
|
|
85
99
|
licenses:
|
|
86
100
|
- MIT
|
|
87
|
-
metadata:
|
|
101
|
+
metadata:
|
|
102
|
+
plugin_type: theme
|
|
88
103
|
post_install_message:
|
|
89
104
|
rdoc_options: []
|
|
90
105
|
require_paths:
|