jekyll-docs-theme 1.0.0.pre.beta.2 → 1.0.0.pre.beta.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.
- checksums.yaml +4 -4
- data/README.md +4 -0
- data/_includes/jekyll-docs-theme/anchor_headings.html +34 -0
- data/_includes/jekyll-docs-theme/toc.html +38 -0
- data/_includes/jekyll-docs-theme/vendor/anchor_headings.html +5 -4
- data/_includes/sidebar/content-post.html +0 -0
- data/_includes/sidebar/content-pre.html +0 -0
- data/_includes/sidebar/content.html +10 -0
- data/_layouts/default.html +7 -1
- data/_layouts/full.html +1 -9
- data/_layouts/page.html +5 -24
- metadata +7 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 139d521fa6b19976dcaca60d33e370fd6da0dd530837ed347fca256fcf0b78b8
|
|
4
|
+
data.tar.gz: bf2c0410e56d0a65fb26b4a5ed52d37843b0dc4f2adb9eb4c1cd58b01f484123
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1e6f5862d29145ca552015f624e0a59e961fcea8b37f3756904f821097f1d93af93ecc5eeadebfa5c3d539a6fb487e6c5340260d6bb327cf8f29be443ccb097f
|
|
7
|
+
data.tar.gz: ca833360cbe4e61fbab0731db6c2735a0b44fd65788bfd426d1de255eee476523f6a353d783a9ccce50f876dfffc7dd03a156cddc0ff35ac7858cfe65c960ca2
|
data/README.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# Jekyll Docs Theme
|
|
2
2
|
|
|
3
|
+
[](https://rubygems.org/gems/jekyll-docs-theme)
|
|
4
|
+
[](https://github.com/allejo/jekyll-docs-theme/releases)
|
|
5
|
+
[](https://github.com/allejo/jekyll-docs-theme/blob/master/LICENSE.md)
|
|
6
|
+
|
|
3
7
|
A Jekyll theme inspired by Bootstrap's official documentation theme from a few years back. This theme started off by stealing all of Bootstrap Docs' CSS and being used in [mistic100's theme](https://github.com/mistic100/jekyll-bootstrap-doc). This theme has since be rewritten from scratch and remains solely inspired by the original design.
|
|
4
8
|
|
|
5
9
|
This theme is designed for writing documentation websites instead of having large unmaintainable README files or several markdown files inside of a folder in a repository.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
{% assign fm_anchorClass = layout.anchor_headings.anchorClass | default: page.anchor_headings.anchorClass | default: "" %}
|
|
2
|
+
|
|
3
|
+
{% capture anchorClass -%}
|
|
4
|
+
{{- include.anchorClass -}}
|
|
5
|
+
{%- if fm_anchorClass -%}
|
|
6
|
+
.{{- fm_anchorClass -}}
|
|
7
|
+
{%- endif -%}
|
|
8
|
+
{%- endcapture %}
|
|
9
|
+
|
|
10
|
+
{% assign beforeHeading = page.anchor_headings.beforeHeading | default: layout.anchor_headings.beforeHeading | default: false %}
|
|
11
|
+
{% assign anchorAttrs = page.anchor_headings.anchorAttrs | default: layout.anchor_headings.anchorAttrs | default: '' %}
|
|
12
|
+
{% assign anchorBody = page.anchor_headings.anchorBody | default: layout.anchor_headings.anchorBody | default: "#" %}
|
|
13
|
+
{% assign anchorTitle = page.anchor_headings.anchorTitle | default: layout.anchor_headings.anchorTitle | default: '' %}
|
|
14
|
+
{% assign h_min = page.anchor_headings.h_min | default: layout.anchor_headings.h_min | default: 1 %}
|
|
15
|
+
{% assign h_max = page.anchor_headings.h_max | default: layout.anchor_headings.h_max | default: 6 %}
|
|
16
|
+
{% assign bodyPrefix = page.anchor_headings.bodyPrefix | default: layout.anchor_headings.bodyPrefix | default: '' %}
|
|
17
|
+
{% assign bodySuffix = page.anchor_headings.bodySuffix | default: layout.anchor_headings.bodySuffix | default: '' %}
|
|
18
|
+
|
|
19
|
+
{% unless page.disable_anchors %}
|
|
20
|
+
{% include jekyll-docs-theme/vendor/anchor_headings.html
|
|
21
|
+
html=content
|
|
22
|
+
beforeHeading=beforeHeading
|
|
23
|
+
anchorAttrs=anchorAttrs
|
|
24
|
+
anchorBody=anchorBody
|
|
25
|
+
anchorClass=anchorClass
|
|
26
|
+
anchorTitle=anchorTitle
|
|
27
|
+
h_min=h_min
|
|
28
|
+
h_max=h_max
|
|
29
|
+
bodyPrefix=bodyPrefix
|
|
30
|
+
bodySuffix=bodySuffix
|
|
31
|
+
%}
|
|
32
|
+
{% else %}
|
|
33
|
+
{{ content }}
|
|
34
|
+
{% endunless %}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
{% assign fm_class = layout.table_of_contents.class | default: page.table_of_contents.class | default: "" %}
|
|
2
|
+
{% assign fm_anchor_class = layout.table_of_contents.anchor_class | default: page.table_of_contents.anchor_class | default: "" %}
|
|
3
|
+
|
|
4
|
+
{% capture class -%}
|
|
5
|
+
{{- include.class -}}
|
|
6
|
+
{%- if fm_class -%}
|
|
7
|
+
.{{- fm_class -}}
|
|
8
|
+
{%- endif -%}
|
|
9
|
+
{%- endcapture %}
|
|
10
|
+
|
|
11
|
+
{% capture anchor_class %}
|
|
12
|
+
{{- include.anchor_class -}}
|
|
13
|
+
{%- if fm_anchor_class -%}
|
|
14
|
+
.{{- fm_anchor_class -}}
|
|
15
|
+
{%- endif -%}
|
|
16
|
+
{% endcapture %}
|
|
17
|
+
|
|
18
|
+
{% assign sanitize = page.table_of_contents.sanitize | default: layout.table_of_contents.sanitize | default: false %}
|
|
19
|
+
{% assign h_min = page.table_of_contents.h_min | default: layout.table_of_contents.h_min | default: 1 %}
|
|
20
|
+
{% assign h_max = page.table_of_contents.h_max | default: layout.table_of_contents.h_max | default: 3 %}
|
|
21
|
+
{% assign ordered = page.table_of_contents.ordered | default: layout.table_of_contents.ordered | default: false %}
|
|
22
|
+
{% assign item_class = page.table_of_contents.item_class | default: layout.table_of_contents.item_class | default: '' %}
|
|
23
|
+
{% assign baseurl = page.table_of_contents.baseurl | default: layout.table_of_contents.baseurl | default: '' %}
|
|
24
|
+
{% assign skipNoIDs = page.table_of_contents.skipNoIDs | default: layout.table_of_contents.skipNoIDs | default: false %}
|
|
25
|
+
|
|
26
|
+
{% include jekyll-docs-theme/vendor/toc.html
|
|
27
|
+
html=content
|
|
28
|
+
id=include.id
|
|
29
|
+
class=class
|
|
30
|
+
sanitize=sanitize
|
|
31
|
+
h_min=h_min
|
|
32
|
+
h_max=h_max
|
|
33
|
+
ordered=ordered
|
|
34
|
+
item_class=item_class
|
|
35
|
+
baseurl=baseurl
|
|
36
|
+
anchor_class=anchor_class
|
|
37
|
+
skipNoIDs=skipNoIDs
|
|
38
|
+
%}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{% capture headingsWorkspace %}
|
|
2
2
|
{% comment %}
|
|
3
|
-
Version 1.0.
|
|
3
|
+
Version 1.0.6
|
|
4
4
|
https://github.com/allejo/jekyll-anchor-headings
|
|
5
5
|
|
|
6
6
|
"Be the pull request you wish to see in the world." ~Ben Balter
|
|
@@ -13,7 +13,8 @@
|
|
|
13
13
|
|
|
14
14
|
Optional Parameters:
|
|
15
15
|
* beforeHeading (bool) : false - Set to true if the anchor should be placed _before_ the heading's content
|
|
16
|
-
* anchorAttrs (string) : '' - Any custom HTML attributes that will be added to the `<a>` tag; you may NOT use `href`, `class` or `title
|
|
16
|
+
* anchorAttrs (string) : '' - Any custom HTML attributes that will be added to the `<a>` tag; you may NOT use `href`, `class` or `title`;
|
|
17
|
+
the `%heading%` placeholder is available
|
|
17
18
|
* anchorBody (string) : '' - The content that will be placed inside the anchor; the `%heading%` placeholder is available
|
|
18
19
|
* anchorClass (string) : '' - The class(es) that will be used for each anchor. Separate multiple classes with a space
|
|
19
20
|
* anchorTitle (string) : '' - The `title` attribute that will be used for anchors
|
|
@@ -80,7 +81,7 @@
|
|
|
80
81
|
{% endif %}
|
|
81
82
|
|
|
82
83
|
{% if include.anchorAttrs %}
|
|
83
|
-
{% capture anchor %}{{ anchor }} {{ include.anchorAttrs }}{% endcapture %}
|
|
84
|
+
{% capture anchor %}{{ anchor }} {{ include.anchorAttrs | replace: '%heading%', header }}{% endcapture %}
|
|
84
85
|
{% endif %}
|
|
85
86
|
|
|
86
87
|
{% capture anchor %}<a {{ anchor }}>{{ include.anchorBody | replace: '%heading%', header | default: '' }}</a>{% endcapture %}
|
|
@@ -106,4 +107,4 @@
|
|
|
106
107
|
{% endcapture %}
|
|
107
108
|
{% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
|
|
108
109
|
{% endfor %}
|
|
109
|
-
{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}
|
|
110
|
+
{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}
|
|
File without changes
|
|
File without changes
|
data/_layouts/default.html
CHANGED
|
@@ -4,7 +4,13 @@
|
|
|
4
4
|
{% include head/full.html %}
|
|
5
5
|
</head>
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
{% assign scrollSpyOffset = page.scrollSpyOffset | default: layout.scrollSpyOffset | default: 0 %}
|
|
8
|
+
<body
|
|
9
|
+
class="layout-{{ page.layout }}"
|
|
10
|
+
data-spy="scroll"
|
|
11
|
+
data-target="#page-toc"
|
|
12
|
+
data-offset="{{ scrollSpyOffset }}"
|
|
13
|
+
>
|
|
8
14
|
{% include navigation.html %}
|
|
9
15
|
{% include masthead.html %}
|
|
10
16
|
|
data/_layouts/full.html
CHANGED
|
@@ -4,15 +4,7 @@ layout: default
|
|
|
4
4
|
|
|
5
5
|
<div class="container">
|
|
6
6
|
<main class="layout-full__main scope-markdown">
|
|
7
|
-
{%
|
|
8
|
-
{% include jekyll-docs-theme/vendor/anchor_headings.html
|
|
9
|
-
html=content
|
|
10
|
-
anchorBody="#"
|
|
11
|
-
anchorClass="heading-anchor"
|
|
12
|
-
%}
|
|
13
|
-
{% else %}
|
|
14
|
-
{{ content }}
|
|
15
|
-
{% endunless %}
|
|
7
|
+
{% include jekyll-docs-theme/anchor_headings.html %}
|
|
16
8
|
</main>
|
|
17
9
|
|
|
18
10
|
{% include disqus.html %}
|
data/_layouts/page.html
CHANGED
|
@@ -19,40 +19,21 @@ layout: default
|
|
|
19
19
|
</button>
|
|
20
20
|
</div>
|
|
21
21
|
|
|
22
|
-
{% include jekyll-docs-theme/
|
|
23
|
-
html=content
|
|
22
|
+
{% include jekyll-docs-theme/toc.html
|
|
24
23
|
class="js-toc.mb-0.mt-2"
|
|
25
24
|
id="mobileTOC"
|
|
26
|
-
h_max=3
|
|
27
25
|
%}
|
|
28
26
|
</section>
|
|
29
27
|
|
|
30
28
|
<section class="scope-markdown">
|
|
31
|
-
{%
|
|
32
|
-
{% include jekyll-docs-theme/vendor/anchor_headings.html
|
|
33
|
-
html=content
|
|
34
|
-
anchorBody="#"
|
|
35
|
-
anchorClass="heading-anchor"
|
|
36
|
-
%}
|
|
37
|
-
{% else %}
|
|
38
|
-
{{ content }}
|
|
39
|
-
{% endunless %}
|
|
29
|
+
{% include jekyll-docs-theme/anchor_headings.html %}
|
|
40
30
|
</section>
|
|
41
31
|
</main>
|
|
42
32
|
|
|
43
33
|
<aside class="col-md-3 layout-page__sidebar d-none d-md-block hidden-print">
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
class="list-unstyled.pl-0"
|
|
48
|
-
anchor_class="nav-link.px-3.py-1"
|
|
49
|
-
h_max=3
|
|
50
|
-
%}
|
|
51
|
-
|
|
52
|
-
<a class="px-3 text-muted" href="#top">
|
|
53
|
-
<small>Back to top</small>
|
|
54
|
-
</a>
|
|
55
|
-
</nav>
|
|
34
|
+
{% include sidebar/content-pre.html %}
|
|
35
|
+
{% include sidebar/content.html %}
|
|
36
|
+
{% include sidebar/content-pre.html %}
|
|
56
37
|
</aside>
|
|
57
38
|
</div>
|
|
58
39
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-docs-theme
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.0.pre.beta.
|
|
4
|
+
version: 1.0.0.pre.beta.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Vladimir 'allejo' Jimenez
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-04-
|
|
11
|
+
date: 2020-04-12 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -67,6 +67,8 @@ files:
|
|
|
67
67
|
- _includes/head/stylesheets-pre.html
|
|
68
68
|
- _includes/head/stylesheets.html
|
|
69
69
|
- _includes/internal/variables.html
|
|
70
|
+
- _includes/jekyll-docs-theme/anchor_headings.html
|
|
71
|
+
- _includes/jekyll-docs-theme/toc.html
|
|
70
72
|
- _includes/jekyll-docs-theme/vendor/anchor_headings.html
|
|
71
73
|
- _includes/jekyll-docs-theme/vendor/toc.html
|
|
72
74
|
- _includes/masthead.html
|
|
@@ -74,6 +76,9 @@ files:
|
|
|
74
76
|
- _includes/masthead/buttons.html
|
|
75
77
|
- _includes/masthead/title.html
|
|
76
78
|
- _includes/navigation.html
|
|
79
|
+
- _includes/sidebar/content-post.html
|
|
80
|
+
- _includes/sidebar/content-pre.html
|
|
81
|
+
- _includes/sidebar/content.html
|
|
77
82
|
- _includes/twitter.html
|
|
78
83
|
- _layouts/default.html
|
|
79
84
|
- _layouts/full.html
|