just-the-docs 0.2.4 → 0.2.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/README.md +2 -2
- data/_includes/css/custom.scss.liquid +1 -0
- data/_includes/css/just-the-docs.scss.liquid +7 -0
- data/_includes/head.html +25 -13
- data/_includes/head_custom.html +0 -0
- data/_includes/js/custom.js +0 -0
- data/_includes/nav.html +41 -34
- data/_includes/title.html +5 -0
- data/_includes/vendor/anchor_headings.html +100 -0
- data/_layouts/default.html +100 -39
- data/_layouts/table_wrappers.html +7 -0
- data/_layouts/vendor/compress.html +10 -0
- data/_sass/base.scss +16 -18
- data/_sass/buttons.scss +1 -1
- data/_sass/code.scss +209 -69
- data/_sass/color_schemes/dark.scss +3 -1
- data/_sass/color_schemes/light.scss +0 -0
- data/_sass/content.scss +79 -0
- data/_sass/custom/custom.scss +0 -120
- data/_sass/labels.scss +5 -4
- data/_sass/layout.scss +90 -29
- data/_sass/modules.scss +19 -0
- data/_sass/navigation.scss +4 -32
- data/_sass/search.scss +98 -45
- data/_sass/support/_functions.scss +2 -3
- data/_sass/support/_variables.scss +20 -20
- data/_sass/support/mixins/_layout.scss +1 -3
- data/_sass/support/mixins/_typography.scss +6 -1
- data/_sass/tables.scss +13 -33
- data/_sass/typography.scss +10 -8
- data/_sass/utilities/_layout.scss +75 -18
- data/_sass/utilities/_lists.scss +7 -1
- data/_sass/utilities/_spacing.scss +70 -26
- data/_sass/utilities/_typography.scss +1 -1
- data/assets/css/just-the-docs-dark.scss +3 -0
- data/assets/css/just-the-docs-default.scss +8 -0
- data/assets/css/just-the-docs-light.scss +3 -0
- data/assets/js/just-the-docs.js +240 -103
- data/assets/js/search-data.json +4 -4
- data/assets/js/vendor/lunr.min.js +3 -3
- data/lib/tasks/search.rake +4 -4
- metadata +47 -25
- data/assets/css/dark-mode-preview.scss +0 -41
- data/assets/css/just-the-docs.scss +0 -44
@@ -1,6 +1,6 @@
|
|
1
1
|
/**
|
2
|
-
* lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright -
|
3
|
-
* Copyright (C)
|
2
|
+
* lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.6
|
3
|
+
* Copyright (C) 2019 Oliver Nightingale
|
4
4
|
* @license MIT
|
5
5
|
*/
|
6
|
-
!function(){var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="1.0.0",t.utils={},t.utils.warn=function(t){return function(e){t.console&&console.warn&&console.warn(e)}}(this),t.utils.asString=function(t){return void 0===t||null===t?"":t.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var t=Array.prototype.slice.call(arguments),e=t.pop(),n=t;if("function"!=typeof e)throw new TypeError("last argument must be a function");n.forEach(function(t){this.hasHandler(t)||(this.events[t]=[]),this.events[t].push(e)},this)},t.EventEmitter.prototype.removeListener=function(t,e){if(this.hasHandler(t)){var n=this.events[t].indexOf(e);this.events[t].splice(n,1),this.events[t].length||delete this.events[t]}},t.EventEmitter.prototype.emit=function(t){if(this.hasHandler(t)){var e=Array.prototype.slice.call(arguments,1);this.events[t].forEach(function(t){t.apply(void 0,e)})}},t.EventEmitter.prototype.hasHandler=function(t){return t in this.events},t.tokenizer=function(e){return arguments.length&&null!=e&&void 0!=e?Array.isArray(e)?e.map(function(e){return t.utils.asString(e).toLowerCase()}):e.toString().trim().toLowerCase().split(t.tokenizer.separator):[]},t.tokenizer.separator=/[\s\-]+/,t.tokenizer.load=function(t){var e=this.registeredFunctions[t];if(!e)throw new Error("Cannot load un-registered function: "+t);return e},t.tokenizer.label="default",t.tokenizer.registeredFunctions={"default":t.tokenizer},t.tokenizer.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing tokenizer: "+n),e.label=n,this.registeredFunctions[n]=e},t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.registeredFunctions[e];if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");this._stack.splice(i,0,n)},t.Pipeline.prototype.remove=function(t){var e=this._stack.indexOf(t);-1!=e&&this._stack.splice(e,1)},t.Pipeline.prototype.run=function(t){for(var e=[],n=t.length,i=this._stack.length,r=0;n>r;r++){for(var o=t[r],s=0;i>s&&(o=this._stack[s](o,r,t),void 0!==o&&""!==o);s++);void 0!==o&&""!==o&&e.push(o)}return e},t.Pipeline.prototype.reset=function(){this._stack=[]},t.Pipeline.prototype.toJSON=function(){return this._stack.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Vector=function(){this._magnitude=null,this.list=void 0,this.length=0},t.Vector.Node=function(t,e,n){this.idx=t,this.val=e,this.next=n},t.Vector.prototype.insert=function(e,n){this._magnitude=void 0;var i=this.list;if(!i)return this.list=new t.Vector.Node(e,n,i),this.length++;if(e
|
6
|
+
!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.6",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return void 0===e||null===e?"":e.toString()},e.utils.clone=function(e){if(null===e||void 0===e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i
|
data/lib/tasks/search.rake
CHANGED
@@ -4,7 +4,7 @@ namespace :search do
|
|
4
4
|
puts 'Creating search data json file...'
|
5
5
|
mkdir_p 'assets/js'
|
6
6
|
touch 'assets/js/search-data.json'
|
7
|
-
content = %Q[{{ page.content | markdownify | strip_html | escape_once | remove: 'Table of contents' | remove: '```' | remove: '---' | replace: '\\', ' ' | normalize_whitespace }}]
|
7
|
+
content = %Q[{{ page.content | markdownify | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '</ul', ' . </ul' | replace: '</tr', ' . </tr' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | strip_html | escape_once | remove: 'Table of contents' | remove: '```' | remove: '---' | replace: '\\', ' ' | replace: ' . . . ', ' . ' | replace: ' . . ', ' . ' | normalize_whitespace }}]
|
8
8
|
puts 'Done.'
|
9
9
|
puts 'Generating content...'
|
10
10
|
|
@@ -12,13 +12,13 @@ namespace :search do
|
|
12
12
|
f.puts '---
|
13
13
|
---
|
14
14
|
{
|
15
|
-
{%
|
16
|
-
|
15
|
+
{% assign comma = false %}
|
16
|
+
{% for page in site.html_pages %}{% if page.search_exclude != true %}{% if comma == true%},{% endif %}"{{ forloop.index0 }}": {
|
17
17
|
"title": "{{ page.title | replace: \'&\', \'&\' }}",
|
18
18
|
"content": "'+content+'",
|
19
19
|
"url": "{{ page.url | absolute_url }}",
|
20
20
|
"relUrl": "{{ page.url }}"
|
21
|
-
}{%
|
21
|
+
}{% assign comma = true %}
|
22
22
|
{% endif %}{% endfor %}
|
23
23
|
}'
|
24
24
|
end
|
metadata
CHANGED
@@ -1,29 +1,49 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: just-the-docs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.2.
|
4
|
+
version: 0.2.9
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Patrick Marsceill
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-06-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
|
-
name:
|
14
|
+
name: bundler
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 2.1.4
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 2.1.4
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: jekyll
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
18
32
|
- !ruby/object:Gem::Version
|
19
33
|
version: 3.8.5
|
34
|
+
- - "<"
|
35
|
+
- !ruby/object:Gem::Version
|
36
|
+
version: 4.1.0
|
20
37
|
type: :runtime
|
21
38
|
prerelease: false
|
22
39
|
version_requirements: !ruby/object:Gem::Requirement
|
23
40
|
requirements:
|
24
|
-
- - "
|
41
|
+
- - ">="
|
25
42
|
- !ruby/object:Gem::Version
|
26
43
|
version: 3.8.5
|
44
|
+
- - "<"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: 4.1.0
|
27
47
|
- !ruby/object:Gem::Dependency
|
28
48
|
name: jekyll-seo-tag
|
29
49
|
requirement: !ruby/object:Gem::Requirement
|
@@ -42,30 +62,22 @@ dependencies:
|
|
42
62
|
name: rake
|
43
63
|
requirement: !ruby/object:Gem::Requirement
|
44
64
|
requirements:
|
45
|
-
- - "
|
65
|
+
- - ">="
|
46
66
|
- !ruby/object:Gem::Version
|
47
67
|
version: 12.3.1
|
68
|
+
- - "<"
|
69
|
+
- !ruby/object:Gem::Version
|
70
|
+
version: 13.1.0
|
48
71
|
type: :runtime
|
49
72
|
prerelease: false
|
50
73
|
version_requirements: !ruby/object:Gem::Requirement
|
51
74
|
requirements:
|
52
|
-
- - "
|
75
|
+
- - ">="
|
53
76
|
- !ruby/object:Gem::Version
|
54
77
|
version: 12.3.1
|
55
|
-
-
|
56
|
-
name: bundler
|
57
|
-
requirement: !ruby/object:Gem::Requirement
|
58
|
-
requirements:
|
59
|
-
- - "~>"
|
60
|
-
- !ruby/object:Gem::Version
|
61
|
-
version: 2.0.1
|
62
|
-
type: :development
|
63
|
-
prerelease: false
|
64
|
-
version_requirements: !ruby/object:Gem::Requirement
|
65
|
-
requirements:
|
66
|
-
- - "~>"
|
78
|
+
- - "<"
|
67
79
|
- !ruby/object:Gem::Version
|
68
|
-
version:
|
80
|
+
version: 13.1.0
|
69
81
|
description:
|
70
82
|
email:
|
71
83
|
- patrick.marsceill@gmail.com
|
@@ -77,21 +89,31 @@ files:
|
|
77
89
|
- LICENSE.txt
|
78
90
|
- README.md
|
79
91
|
- Rakefile
|
92
|
+
- _includes/css/custom.scss.liquid
|
93
|
+
- _includes/css/just-the-docs.scss.liquid
|
80
94
|
- _includes/head.html
|
95
|
+
- _includes/head_custom.html
|
96
|
+
- _includes/js/custom.js
|
81
97
|
- _includes/nav.html
|
98
|
+
- _includes/title.html
|
99
|
+
- _includes/vendor/anchor_headings.html
|
82
100
|
- _layouts/about.html
|
83
101
|
- _layouts/default.html
|
84
102
|
- _layouts/home.html
|
85
103
|
- _layouts/page.html
|
86
104
|
- _layouts/post.html
|
105
|
+
- _layouts/table_wrappers.html
|
106
|
+
- _layouts/vendor/compress.html
|
87
107
|
- _sass/base.scss
|
88
108
|
- _sass/buttons.scss
|
89
109
|
- _sass/code.scss
|
90
110
|
- _sass/color_schemes/dark.scss
|
111
|
+
- _sass/color_schemes/light.scss
|
91
112
|
- _sass/content.scss
|
92
113
|
- _sass/custom/custom.scss
|
93
114
|
- _sass/labels.scss
|
94
115
|
- _sass/layout.scss
|
116
|
+
- _sass/modules.scss
|
95
117
|
- _sass/navigation.scss
|
96
118
|
- _sass/search.scss
|
97
119
|
- _sass/support/_functions.scss
|
@@ -112,8 +134,9 @@ files:
|
|
112
134
|
- _sass/vendor/normalize.scss/README.md
|
113
135
|
- _sass/vendor/normalize.scss/normalize.scss
|
114
136
|
- _sass/vendor/normalize.scss/package.json
|
115
|
-
- assets/css/
|
116
|
-
- assets/css/just-the-docs.scss
|
137
|
+
- assets/css/just-the-docs-dark.scss
|
138
|
+
- assets/css/just-the-docs-default.scss
|
139
|
+
- assets/css/just-the-docs-light.scss
|
117
140
|
- assets/images/just-the-docs.png
|
118
141
|
- assets/images/search.svg
|
119
142
|
- assets/js/just-the-docs.js
|
@@ -140,10 +163,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
140
163
|
- !ruby/object:Gem::Version
|
141
164
|
version: '0'
|
142
165
|
requirements: []
|
143
|
-
|
144
|
-
rubygems_version: 2.5.1
|
166
|
+
rubygems_version: 3.0.3
|
145
167
|
signing_key:
|
146
168
|
specification_version: 4
|
147
|
-
summary: A modern,
|
148
|
-
built-in search.
|
169
|
+
summary: A modern, highly customizable, and responsive Jekyll theme for documention
|
170
|
+
with built-in search.
|
149
171
|
test_files: []
|
@@ -1,41 +0,0 @@
|
|
1
|
-
---
|
2
|
-
# this ensures Jekyll reads the file to be transformed into CSS later
|
3
|
-
# only Main files contain this front matter, not partials.
|
4
|
-
---
|
5
|
-
|
6
|
-
//
|
7
|
-
// Import external dependencies
|
8
|
-
//
|
9
|
-
|
10
|
-
@import "./vendor/normalize.scss/normalize.scss";
|
11
|
-
|
12
|
-
//
|
13
|
-
// Import Just the Docs scss
|
14
|
-
//
|
15
|
-
|
16
|
-
// Support
|
17
|
-
@import "./support/support";
|
18
|
-
|
19
|
-
//
|
20
|
-
// Import custom color scheme scss
|
21
|
-
//
|
22
|
-
|
23
|
-
@import "./color_schemes/dark.scss";
|
24
|
-
|
25
|
-
// Modules
|
26
|
-
@import "./base";
|
27
|
-
@import "./layout";
|
28
|
-
@import "./content";
|
29
|
-
@import "./navigation";
|
30
|
-
@import "./typography";
|
31
|
-
@import "./labels";
|
32
|
-
@import "./buttons";
|
33
|
-
@import "./search";
|
34
|
-
@import "./tables";
|
35
|
-
@import "./code";
|
36
|
-
@import "./utilities/utilities";
|
37
|
-
|
38
|
-
//
|
39
|
-
// Import custom overrides
|
40
|
-
//
|
41
|
-
@import "./custom/custom";
|
@@ -1,44 +0,0 @@
|
|
1
|
-
---
|
2
|
-
# this ensures Jekyll reads the file to be transformed into CSS later
|
3
|
-
# only Main files contain this front matter, not partials.
|
4
|
-
---
|
5
|
-
|
6
|
-
//
|
7
|
-
// Import external dependencies
|
8
|
-
//
|
9
|
-
|
10
|
-
@import "./vendor/normalize.scss/normalize.scss";
|
11
|
-
|
12
|
-
//
|
13
|
-
// Import Just the Docs scss
|
14
|
-
//
|
15
|
-
|
16
|
-
// Support
|
17
|
-
@import "./support/support";
|
18
|
-
|
19
|
-
//
|
20
|
-
// Import custom overrides
|
21
|
-
//
|
22
|
-
|
23
|
-
@import "./custom/custom";
|
24
|
-
|
25
|
-
//
|
26
|
-
// Import custom color scheme scss
|
27
|
-
//
|
28
|
-
|
29
|
-
{% if site.color_scheme == "dark" %}
|
30
|
-
@import "./color_schemes/dark.scss";
|
31
|
-
{% endif %}
|
32
|
-
|
33
|
-
// Modules
|
34
|
-
@import "./base";
|
35
|
-
@import "./layout";
|
36
|
-
@import "./content";
|
37
|
-
@import "./navigation";
|
38
|
-
@import "./typography";
|
39
|
-
@import "./labels";
|
40
|
-
@import "./buttons";
|
41
|
-
@import "./search";
|
42
|
-
@import "./tables";
|
43
|
-
@import "./code";
|
44
|
-
@import "./utilities/utilities";
|