fni-docs-theme 0.4.2
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 +7 -0
- data/LICENSE.txt +21 -0
- data/README.md +19 -0
- data/Rakefile +1 -0
- data/_includes/css/custom.scss.liquid +1 -0
- data/_includes/css/just-the-docs.scss.liquid +7 -0
- data/_includes/fix_linenos.html +65 -0
- data/_includes/footer_custom.html +3 -0
- data/_includes/head.html +39 -0
- data/_includes/head_custom.html +0 -0
- data/_includes/header_custom.html +0 -0
- data/_includes/js/custom.js +0 -0
- data/_includes/nav.html +31 -0
- data/_includes/title.html +5 -0
- data/_includes/vendor/anchor_headings.html +144 -0
- data/_layouts/about.html +5 -0
- data/_layouts/default.html +199 -0
- data/_layouts/home.html +5 -0
- data/_layouts/page.html +5 -0
- data/_layouts/post.html +5 -0
- data/_layouts/table_wrappers.html +7 -0
- data/_layouts/vendor/compress.html +10 -0
- data/_sass/base.scss +108 -0
- data/_sass/buttons.scss +118 -0
- data/_sass/code.scss +340 -0
- data/_sass/color_schemes/dark.scss +17 -0
- data/_sass/color_schemes/light.scss +0 -0
- data/_sass/content.scss +231 -0
- data/_sass/custom/custom.scss +0 -0
- data/_sass/labels.scss +37 -0
- data/_sass/layout.scss +205 -0
- data/_sass/modules.scss +20 -0
- data/_sass/navigation.scss +219 -0
- data/_sass/print.scss +40 -0
- data/_sass/search.scss +324 -0
- data/_sass/support/_functions.scss +9 -0
- data/_sass/support/_variables.scss +153 -0
- data/_sass/support/mixins/_buttons.scss +27 -0
- data/_sass/support/mixins/_layout.scss +34 -0
- data/_sass/support/mixins/_typography.scss +84 -0
- data/_sass/support/mixins/mixins.scss +3 -0
- data/_sass/support/support.scss +3 -0
- data/_sass/tables.scss +58 -0
- data/_sass/typography.scss +64 -0
- data/_sass/utilities/_colors.scss +239 -0
- data/_sass/utilities/_layout.scss +95 -0
- data/_sass/utilities/_lists.scss +17 -0
- data/_sass/utilities/_spacing.scss +165 -0
- data/_sass/utilities/_typography.scss +91 -0
- data/_sass/utilities/utilities.scss +5 -0
- data/_sass/vendor/normalize.scss/README.md +7 -0
- data/_sass/vendor/normalize.scss/normalize.scss +349 -0
- 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/images/just-the-docs.png +0 -0
- data/assets/images/search.svg +1 -0
- data/assets/js/jtd-nav.js +35 -0
- data/assets/js/just-the-docs.js +471 -0
- data/assets/js/vendor/lunr.min.js +6 -0
- data/assets/js/zzzz-search-data.json +72 -0
- data/bin/just-the-docs +16 -0
- data/lib/fni-docs-theme.rb +1 -0
- data/lib/generators/nav-generator.rb +31 -0
- data/lib/tasks/search.rake +86 -0
- metadata +200 -0
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
namespace :search do
|
|
2
|
+
desc 'Generate the files needed for search functionality'
|
|
3
|
+
task :init do
|
|
4
|
+
puts 'Creating search data json file...'
|
|
5
|
+
mkdir_p 'assets/js'
|
|
6
|
+
touch 'assets/js/zzzz-search-data.json'
|
|
7
|
+
puts 'Done.'
|
|
8
|
+
puts 'Generating content...'
|
|
9
|
+
|
|
10
|
+
File.open('assets/js/zzzz-search-data.json', 'w') do |f|
|
|
11
|
+
f.puts '---
|
|
12
|
+
permalink: /assets/js/search-data.json
|
|
13
|
+
---
|
|
14
|
+
{
|
|
15
|
+
{%- assign i = 0 -%}
|
|
16
|
+
{%- assign pages_array = '' | split: '' -%}
|
|
17
|
+
{%- assign pages_array = pages_array | push: site.html_pages -%}
|
|
18
|
+
{%- if site.just_the_docs.collections -%}
|
|
19
|
+
{%- for collection_entry in site.just_the_docs.collections -%}
|
|
20
|
+
{%- assign collection_key = collection_entry[0] -%}
|
|
21
|
+
{%- assign collection_value = collection_entry[1] -%}
|
|
22
|
+
{%- assign collection = site[collection_key] -%}
|
|
23
|
+
{%- if collection_value.search_exclude != true -%}
|
|
24
|
+
{%- assign pages_array = pages_array | push: collection -%}
|
|
25
|
+
{%- endif -%}
|
|
26
|
+
{%- endfor -%}
|
|
27
|
+
{%- endif -%}
|
|
28
|
+
{%- for pages in pages_array -%}
|
|
29
|
+
{%- for page in pages -%}
|
|
30
|
+
{%- if page.title and page.search_exclude != true -%}
|
|
31
|
+
{%- assign page_content = page.content -%}
|
|
32
|
+
{%- assign heading_level = site.search.heading_level | default: 2 -%}
|
|
33
|
+
{%- for j in (2..heading_level) -%}
|
|
34
|
+
{%- assign tag = \'<h\' | append: j -%}
|
|
35
|
+
{%- assign closing_tag = \'</h\' | append: j -%}
|
|
36
|
+
{%- assign page_content = page_content | replace: tag, \'<h1\' | replace: closing_tag, \'</h1\' -%}
|
|
37
|
+
{%- endfor -%}
|
|
38
|
+
{%- assign parts = page_content | split: \'<h1\' -%}
|
|
39
|
+
{%- assign title_found = false -%}
|
|
40
|
+
{%- for part in parts offset: 1 -%}
|
|
41
|
+
{%- assign titleAndContent = part | split: \'</h1>\' -%}
|
|
42
|
+
{%- assign title = titleAndContent[0] | replace_first: \'>\', \'<h1>\' | split: \'<h1>\' -%}
|
|
43
|
+
{%- assign title = title[1] | strip_html -%}
|
|
44
|
+
{%- assign content = titleAndContent[1] -%}
|
|
45
|
+
{%- assign url = page.url -%}
|
|
46
|
+
{%- if title == page.title and parts[0] == \'\' -%}
|
|
47
|
+
{%- assign title_found = true -%}
|
|
48
|
+
{%- else -%}
|
|
49
|
+
{%- assign id = titleAndContent[0] -%}
|
|
50
|
+
{%- assign id = id | split: \'id="\' -%}
|
|
51
|
+
{%- if id.size == 2 -%}
|
|
52
|
+
{%- assign id = id[1] -%}
|
|
53
|
+
{%- assign id = id | split: \'"\' -%}
|
|
54
|
+
{%- assign id = id[0] -%}
|
|
55
|
+
{%- capture url -%}{{ url | append: \'#\' | append: id }}{%- endcapture -%}
|
|
56
|
+
{%- endif -%}
|
|
57
|
+
{%- endif -%}
|
|
58
|
+
{%- unless i == 0 -%},{%- endunless -%}
|
|
59
|
+
"{{ i }}": {
|
|
60
|
+
"doc": {{ page.title | jsonify }},
|
|
61
|
+
"title": {{ title | jsonify }},
|
|
62
|
+
"content": {{ content | replace: \'</h\', \' . </h\' | replace: \'<hr\', \' . <hr\' | replace: \'</p\', \' . </p\' | replace: \'<ul\', \' . <ul\' | replace: \'</ul\', \' . </ul\' | replace: \'<ol\', \' . <ol\' | replace: \'</ol\', \' . </ol\' | replace: \'</tr\', \' . </tr\' | replace: \'<li\', \' | <li\' | replace: \'</li\', \' | </li\' | replace: \'</td\', \' | </td\' | replace: \'<td\', \' | <td\' | replace: \'</th\', \' | </th\' | replace: \'<th\', \' | <th\' | strip_html | remove: \'Table of contents\' | normalize_whitespace | replace: \'. . .\', \'.\' | replace: \'. .\', \'.\' | replace: \'| |\', \'|\' | append: \' \' | jsonify }},
|
|
63
|
+
"url": "{{ url | relative_url }}",
|
|
64
|
+
"relUrl": "{{ url }}"
|
|
65
|
+
}
|
|
66
|
+
{%- assign i = i | plus: 1 -%}
|
|
67
|
+
{%- endfor -%}
|
|
68
|
+
{%- unless title_found -%}
|
|
69
|
+
{%- unless i == 0 -%},{%- endunless -%}
|
|
70
|
+
"{{ i }}": {
|
|
71
|
+
"doc": {{ page.title | jsonify }},
|
|
72
|
+
"title": {{ page.title | jsonify }},
|
|
73
|
+
"content": {{ parts[0] | replace: \'</h\', \' . </h\' | replace: \'<hr\', \' . <hr\' | replace: \'</p\', \' . </p\' | replace: \'<ul\', \' . <ul\' | replace: \'</ul\', \' . </ul\' | replace: \'<ol\', \' . <ol\' | replace: \'</ol\', \' . </ol\' | replace: \'</tr\', \' . </tr\' | replace: \'<li\', \' | <li\' | replace: \'</li\', \' | </li\' | replace: \'</td\', \' | </td\' | replace: \'<td\', \' | <td\' | replace: \'</th\', \' | </th\' | replace: \'<th\', \' | <th\' | strip_html | remove: \'Table of contents\' | normalize_whitespace | replace: \'. . .\', \'.\' | replace: \'. .\', \'.\' | replace: \'| |\', \'|\' | append: \' \' | jsonify }},
|
|
74
|
+
"url": "{{ page.url | relative_url }}",
|
|
75
|
+
"relUrl": "{{ page.url }}"
|
|
76
|
+
}
|
|
77
|
+
{%- assign i = i | plus: 1 -%}
|
|
78
|
+
{%- endunless -%}
|
|
79
|
+
{%- endif -%}
|
|
80
|
+
{%- endfor -%}
|
|
81
|
+
{%- endfor %}
|
|
82
|
+
}'
|
|
83
|
+
end
|
|
84
|
+
puts 'Done.'
|
|
85
|
+
end
|
|
86
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: fni-docs-theme
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.4.2
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Patrick Marsceill
|
|
8
|
+
- Ken Hill
|
|
9
|
+
autorequire:
|
|
10
|
+
bindir: bin
|
|
11
|
+
cert_chain: []
|
|
12
|
+
date: 2022-01-27 00:00:00.000000000 Z
|
|
13
|
+
dependencies:
|
|
14
|
+
- !ruby/object:Gem::Dependency
|
|
15
|
+
name: bundler
|
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
|
17
|
+
requirements:
|
|
18
|
+
- - "~>"
|
|
19
|
+
- !ruby/object:Gem::Version
|
|
20
|
+
version: 2.3.5
|
|
21
|
+
type: :development
|
|
22
|
+
prerelease: false
|
|
23
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
24
|
+
requirements:
|
|
25
|
+
- - "~>"
|
|
26
|
+
- !ruby/object:Gem::Version
|
|
27
|
+
version: 2.3.5
|
|
28
|
+
- !ruby/object:Gem::Dependency
|
|
29
|
+
name: jekyll
|
|
30
|
+
requirement: !ruby/object:Gem::Requirement
|
|
31
|
+
requirements:
|
|
32
|
+
- - "~>"
|
|
33
|
+
- !ruby/object:Gem::Version
|
|
34
|
+
version: 4.2.0
|
|
35
|
+
type: :runtime
|
|
36
|
+
prerelease: false
|
|
37
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
38
|
+
requirements:
|
|
39
|
+
- - "~>"
|
|
40
|
+
- !ruby/object:Gem::Version
|
|
41
|
+
version: 4.2.0
|
|
42
|
+
- !ruby/object:Gem::Dependency
|
|
43
|
+
name: jekyll-include-cache
|
|
44
|
+
requirement: !ruby/object:Gem::Requirement
|
|
45
|
+
requirements:
|
|
46
|
+
- - "~>"
|
|
47
|
+
- !ruby/object:Gem::Version
|
|
48
|
+
version: 0.2.1
|
|
49
|
+
type: :runtime
|
|
50
|
+
prerelease: false
|
|
51
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
52
|
+
requirements:
|
|
53
|
+
- - "~>"
|
|
54
|
+
- !ruby/object:Gem::Version
|
|
55
|
+
version: 0.2.1
|
|
56
|
+
- !ruby/object:Gem::Dependency
|
|
57
|
+
name: rake
|
|
58
|
+
requirement: !ruby/object:Gem::Requirement
|
|
59
|
+
requirements:
|
|
60
|
+
- - ">="
|
|
61
|
+
- !ruby/object:Gem::Version
|
|
62
|
+
version: 12.3.1
|
|
63
|
+
- - "<"
|
|
64
|
+
- !ruby/object:Gem::Version
|
|
65
|
+
version: 13.1.0
|
|
66
|
+
type: :runtime
|
|
67
|
+
prerelease: false
|
|
68
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
69
|
+
requirements:
|
|
70
|
+
- - ">="
|
|
71
|
+
- !ruby/object:Gem::Version
|
|
72
|
+
version: 12.3.1
|
|
73
|
+
- - "<"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: 13.1.0
|
|
76
|
+
- !ruby/object:Gem::Dependency
|
|
77
|
+
name: webrick
|
|
78
|
+
requirement: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: '1.7'
|
|
83
|
+
type: :runtime
|
|
84
|
+
prerelease: false
|
|
85
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - "~>"
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: '1.7'
|
|
90
|
+
- !ruby/object:Gem::Dependency
|
|
91
|
+
name: digest
|
|
92
|
+
requirement: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - "~>"
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: '3.0'
|
|
97
|
+
type: :runtime
|
|
98
|
+
prerelease: false
|
|
99
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
100
|
+
requirements:
|
|
101
|
+
- - "~>"
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: '3.0'
|
|
104
|
+
description:
|
|
105
|
+
email:
|
|
106
|
+
- patrick.marsceill@gmail.com
|
|
107
|
+
- rubygems@hill.ae
|
|
108
|
+
executables:
|
|
109
|
+
- just-the-docs
|
|
110
|
+
extensions: []
|
|
111
|
+
extra_rdoc_files: []
|
|
112
|
+
files:
|
|
113
|
+
- LICENSE.txt
|
|
114
|
+
- README.md
|
|
115
|
+
- Rakefile
|
|
116
|
+
- _includes/css/custom.scss.liquid
|
|
117
|
+
- _includes/css/just-the-docs.scss.liquid
|
|
118
|
+
- _includes/fix_linenos.html
|
|
119
|
+
- _includes/footer_custom.html
|
|
120
|
+
- _includes/head.html
|
|
121
|
+
- _includes/head_custom.html
|
|
122
|
+
- _includes/header_custom.html
|
|
123
|
+
- _includes/js/custom.js
|
|
124
|
+
- _includes/nav.html
|
|
125
|
+
- _includes/title.html
|
|
126
|
+
- _includes/vendor/anchor_headings.html
|
|
127
|
+
- _layouts/about.html
|
|
128
|
+
- _layouts/default.html
|
|
129
|
+
- _layouts/home.html
|
|
130
|
+
- _layouts/page.html
|
|
131
|
+
- _layouts/post.html
|
|
132
|
+
- _layouts/table_wrappers.html
|
|
133
|
+
- _layouts/vendor/compress.html
|
|
134
|
+
- _sass/base.scss
|
|
135
|
+
- _sass/buttons.scss
|
|
136
|
+
- _sass/code.scss
|
|
137
|
+
- _sass/color_schemes/dark.scss
|
|
138
|
+
- _sass/color_schemes/light.scss
|
|
139
|
+
- _sass/content.scss
|
|
140
|
+
- _sass/custom/custom.scss
|
|
141
|
+
- _sass/labels.scss
|
|
142
|
+
- _sass/layout.scss
|
|
143
|
+
- _sass/modules.scss
|
|
144
|
+
- _sass/navigation.scss
|
|
145
|
+
- _sass/print.scss
|
|
146
|
+
- _sass/search.scss
|
|
147
|
+
- _sass/support/_functions.scss
|
|
148
|
+
- _sass/support/_variables.scss
|
|
149
|
+
- _sass/support/mixins/_buttons.scss
|
|
150
|
+
- _sass/support/mixins/_layout.scss
|
|
151
|
+
- _sass/support/mixins/_typography.scss
|
|
152
|
+
- _sass/support/mixins/mixins.scss
|
|
153
|
+
- _sass/support/support.scss
|
|
154
|
+
- _sass/tables.scss
|
|
155
|
+
- _sass/typography.scss
|
|
156
|
+
- _sass/utilities/_colors.scss
|
|
157
|
+
- _sass/utilities/_layout.scss
|
|
158
|
+
- _sass/utilities/_lists.scss
|
|
159
|
+
- _sass/utilities/_spacing.scss
|
|
160
|
+
- _sass/utilities/_typography.scss
|
|
161
|
+
- _sass/utilities/utilities.scss
|
|
162
|
+
- _sass/vendor/normalize.scss/README.md
|
|
163
|
+
- _sass/vendor/normalize.scss/normalize.scss
|
|
164
|
+
- assets/css/just-the-docs-dark.scss
|
|
165
|
+
- assets/css/just-the-docs-default.scss
|
|
166
|
+
- assets/css/just-the-docs-light.scss
|
|
167
|
+
- assets/images/just-the-docs.png
|
|
168
|
+
- assets/images/search.svg
|
|
169
|
+
- assets/js/jtd-nav.js
|
|
170
|
+
- assets/js/just-the-docs.js
|
|
171
|
+
- assets/js/vendor/lunr.min.js
|
|
172
|
+
- assets/js/zzzz-search-data.json
|
|
173
|
+
- bin/just-the-docs
|
|
174
|
+
- lib/fni-docs-theme.rb
|
|
175
|
+
- lib/generators/nav-generator.rb
|
|
176
|
+
- lib/tasks/search.rake
|
|
177
|
+
homepage: https://github.com/dealertrack/fni-docs-theme
|
|
178
|
+
licenses:
|
|
179
|
+
- MIT
|
|
180
|
+
metadata: {}
|
|
181
|
+
post_install_message:
|
|
182
|
+
rdoc_options: []
|
|
183
|
+
require_paths:
|
|
184
|
+
- lib
|
|
185
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
186
|
+
requirements:
|
|
187
|
+
- - ">="
|
|
188
|
+
- !ruby/object:Gem::Version
|
|
189
|
+
version: '0'
|
|
190
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
191
|
+
requirements:
|
|
192
|
+
- - ">="
|
|
193
|
+
- !ruby/object:Gem::Version
|
|
194
|
+
version: '0'
|
|
195
|
+
requirements: []
|
|
196
|
+
rubygems_version: 3.2.15
|
|
197
|
+
signing_key:
|
|
198
|
+
specification_version: 4
|
|
199
|
+
summary: Fork of just-the-docs
|
|
200
|
+
test_files: []
|