jazzy 0.13.0 → 0.13.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.circleci/config.yml +3 -3
- data/.gitignore +1 -0
- data/CHANGELOG.md +153 -0
- data/CONTRIBUTING.md +1 -1
- data/Gemfile.lock +49 -38
- data/README.md +30 -0
- data/Rakefile +30 -0
- data/bin/sourcekitten +0 -0
- data/images/math.png +0 -0
- data/jazzy.gemspec +3 -3
- data/js/package-lock.json +39 -0
- data/js/package.json +17 -0
- data/lib/jazzy/config.rb +40 -2
- data/lib/jazzy/doc.rb +4 -0
- data/lib/jazzy/doc_builder.rb +47 -17
- data/lib/jazzy/docset_builder.rb +2 -0
- data/lib/jazzy/docset_builder/info_plist.mustache +8 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_AMS-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Caligraphic-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Fraktur-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-BoldItalic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Main-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-BoldItalic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Math-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Bold.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Italic.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_SansSerif-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Script-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size1-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size2-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size3-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Size4-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.ttf +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff +0 -0
- data/lib/jazzy/extensions/katex/css/fonts/KaTeX_Typewriter-Regular.woff2 +0 -0
- data/lib/jazzy/extensions/katex/css/katex.min.css +1 -0
- data/lib/jazzy/extensions/katex/js/katex.min.js +1 -0
- data/lib/jazzy/gem_version.rb +1 -1
- data/lib/jazzy/jazzy_markdown.rb +17 -0
- data/lib/jazzy/podspec_documenter.rb +15 -3
- data/lib/jazzy/source_declaration.rb +15 -2
- data/lib/jazzy/source_declaration/access_control_level.rb +1 -1
- data/lib/jazzy/source_declaration/type.rb +34 -0
- data/lib/jazzy/source_module.rb +2 -1
- data/lib/jazzy/sourcekitten.rb +52 -22
- data/lib/jazzy/themes/apple/assets/css/jazzy.css.scss +79 -4
- data/lib/jazzy/themes/apple/assets/img/spinner.gif +0 -0
- data/lib/jazzy/themes/apple/assets/js/jazzy.js +12 -1
- data/lib/jazzy/themes/apple/assets/js/jazzy.search.js +70 -0
- data/lib/jazzy/themes/apple/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/apple/assets/js/lunr.min.js +6 -0
- data/lib/jazzy/themes/apple/assets/js/typeahead.jquery.js +1694 -0
- data/lib/jazzy/themes/apple/templates/doc.mustache +41 -0
- data/lib/jazzy/themes/apple/templates/header.mustache +7 -0
- data/lib/jazzy/themes/apple/templates/task.mustache +3 -3
- data/lib/jazzy/themes/fullwidth/assets/css/jazzy.css.scss +3 -1
- data/lib/jazzy/themes/fullwidth/assets/js/jazzy.js +12 -1
- data/lib/jazzy/themes/fullwidth/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/fullwidth/assets/js/lunr.min.js +6 -1
- data/lib/jazzy/themes/fullwidth/assets/js/typeahead.jquery.js +34 -14
- data/lib/jazzy/themes/fullwidth/templates/doc.mustache +36 -0
- data/lib/jazzy/themes/fullwidth/templates/task.mustache +3 -3
- data/lib/jazzy/themes/jony/assets/css/jazzy.css.scss +12 -2
- data/lib/jazzy/themes/jony/assets/js/jazzy.js +12 -1
- data/lib/jazzy/themes/jony/assets/js/jquery.min.js +2 -2
- data/lib/jazzy/themes/jony/templates/doc.mustache +36 -0
- data/lib/jazzy/themes/jony/templates/task.mustache +3 -3
- metadata +75 -5
@@ -18,7 +18,7 @@ $content_wrapper_width: 980px;
|
|
18
18
|
$content_top_offset: 70px;
|
19
19
|
$content_body_margin: 16px;
|
20
20
|
$content_body_left_offset: $sidebar_width + $content_body_margin;
|
21
|
-
$header_height:
|
21
|
+
$header_height: 32px;
|
22
22
|
$breadcrumb_padding_top: 17px;
|
23
23
|
|
24
24
|
$code_font: 0.95em Menlo, monospace;
|
@@ -104,12 +104,18 @@ p code, li code {
|
|
104
104
|
padding: 2px 4px;
|
105
105
|
border-radius: 4px;
|
106
106
|
}
|
107
|
+
pre > code {
|
108
|
+
padding: 0;
|
109
|
+
}
|
107
110
|
|
108
111
|
// Links
|
109
112
|
|
110
113
|
a {
|
111
114
|
color: $link_color;
|
112
115
|
text-decoration: none;
|
116
|
+
code {
|
117
|
+
color: inherit;
|
118
|
+
}
|
113
119
|
}
|
114
120
|
|
115
121
|
// Lists
|
@@ -152,7 +158,7 @@ header {
|
|
152
158
|
background-color: $bg_color;
|
153
159
|
position: fixed;
|
154
160
|
width: 100%;
|
155
|
-
z-index:
|
161
|
+
z-index: 3;
|
156
162
|
img {
|
157
163
|
padding-right: 6px;
|
158
164
|
vertical-align: -4px;
|
@@ -309,6 +315,7 @@ header {
|
|
309
315
|
}
|
310
316
|
|
311
317
|
.task-group-section {
|
318
|
+
margin-top: 10px;
|
312
319
|
padding-left: 6px;
|
313
320
|
border-top: $gray_border;
|
314
321
|
}
|
@@ -368,13 +375,15 @@ header {
|
|
368
375
|
padding: 0;
|
369
376
|
}
|
370
377
|
.token, .direct-link {
|
378
|
+
display: inline-block;
|
379
|
+
text-indent: -20px;
|
371
380
|
padding-left: 3px;
|
372
|
-
margin-left:
|
381
|
+
margin-left: 35px;
|
373
382
|
font-size: 11.9px;
|
374
383
|
transition: all 300ms;
|
375
384
|
}
|
376
385
|
.token-open {
|
377
|
-
margin-left:
|
386
|
+
margin-left: 20px;
|
378
387
|
}
|
379
388
|
.discouraged {
|
380
389
|
text-decoration: line-through;
|
@@ -527,3 +536,69 @@ html.dash {
|
|
527
536
|
position: static;
|
528
537
|
}
|
529
538
|
}
|
539
|
+
|
540
|
+
// ===========================================================================
|
541
|
+
//
|
542
|
+
// Search
|
543
|
+
//
|
544
|
+
// ===========================================================================
|
545
|
+
form[role=search] {
|
546
|
+
float: right;
|
547
|
+
|
548
|
+
input {
|
549
|
+
font: Helvetica, freesans, Arial, sans-serif;
|
550
|
+
margin-top: 6px;
|
551
|
+
font-size: 13px;
|
552
|
+
line-height: 20px;
|
553
|
+
padding: 0px 10px;
|
554
|
+
border: none;
|
555
|
+
border-radius: 1em;
|
556
|
+
.loading & {
|
557
|
+
background: white url(../img/spinner.gif) center right 4px no-repeat;
|
558
|
+
}
|
559
|
+
}
|
560
|
+
|
561
|
+
// Typeahead elements
|
562
|
+
|
563
|
+
.tt-menu {
|
564
|
+
margin: 0;
|
565
|
+
min-width: 300px;
|
566
|
+
background: $white_color;
|
567
|
+
color: #333;
|
568
|
+
border: $gray_border;
|
569
|
+
z-index: 4;
|
570
|
+
}
|
571
|
+
|
572
|
+
.tt-highlight {
|
573
|
+
font-weight: bold;
|
574
|
+
}
|
575
|
+
|
576
|
+
.tt-suggestion {
|
577
|
+
font: Helvetica, freesans, Arial, sans-serif;
|
578
|
+
font-size: 14px;
|
579
|
+
padding: 0 8px;
|
580
|
+
span {
|
581
|
+
display: table-cell;
|
582
|
+
white-space: nowrap;
|
583
|
+
}
|
584
|
+
.doc-parent-name {
|
585
|
+
width: 100%;
|
586
|
+
text-align: right;
|
587
|
+
font-weight: normal;
|
588
|
+
font-size: 0.9em;
|
589
|
+
padding-left: 16px;
|
590
|
+
}
|
591
|
+
}
|
592
|
+
|
593
|
+
.tt-suggestion:hover,
|
594
|
+
.tt-suggestion.tt-cursor {
|
595
|
+
cursor: pointer;
|
596
|
+
background-color: #4183c4;
|
597
|
+
color: #fff;
|
598
|
+
}
|
599
|
+
|
600
|
+
.tt-suggestion:hover .doc-parent-name,
|
601
|
+
.tt-suggestion.tt-cursor .doc-parent-name {
|
602
|
+
color: #fff;
|
603
|
+
}
|
604
|
+
}
|
Binary file
|
@@ -23,7 +23,7 @@ function openCurrentItemIfClosed() {
|
|
23
23
|
if (window.jazzy.docset) {
|
24
24
|
return;
|
25
25
|
}
|
26
|
-
var $link = $(
|
26
|
+
var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token');
|
27
27
|
$content = itemLinkToContent($link);
|
28
28
|
if ($content.is(':hidden')) {
|
29
29
|
toggleItem($link, $content);
|
@@ -57,3 +57,14 @@ $("a:not('.token')").on('click', function() {
|
|
57
57
|
openCurrentItemIfClosed();
|
58
58
|
}
|
59
59
|
});
|
60
|
+
|
61
|
+
// KaTeX rendering
|
62
|
+
if ("katex" in window) {
|
63
|
+
$($('.math').each( (_, element) => {
|
64
|
+
katex.render(element.textContent, element, {
|
65
|
+
displayMode: $(element).hasClass('m-block'),
|
66
|
+
throwOnError: false,
|
67
|
+
trust: true
|
68
|
+
});
|
69
|
+
}))
|
70
|
+
}
|
@@ -0,0 +1,70 @@
|
|
1
|
+
$(function(){
|
2
|
+
var $typeahead = $('[data-typeahead]');
|
3
|
+
var $form = $typeahead.parents('form');
|
4
|
+
var searchURL = $form.attr('action');
|
5
|
+
|
6
|
+
function displayTemplate(result) {
|
7
|
+
return result.name;
|
8
|
+
}
|
9
|
+
|
10
|
+
function suggestionTemplate(result) {
|
11
|
+
var t = '<div class="list-group-item clearfix">';
|
12
|
+
t += '<span class="doc-name">' + result.name + '</span>';
|
13
|
+
if (result.parent_name) {
|
14
|
+
t += '<span class="doc-parent-name label">' + result.parent_name + '</span>';
|
15
|
+
}
|
16
|
+
t += '</div>';
|
17
|
+
return t;
|
18
|
+
}
|
19
|
+
|
20
|
+
$typeahead.one('focus', function() {
|
21
|
+
$form.addClass('loading');
|
22
|
+
|
23
|
+
$.getJSON(searchURL).then(function(searchData) {
|
24
|
+
const searchIndex = lunr(function() {
|
25
|
+
this.ref('url');
|
26
|
+
this.field('name');
|
27
|
+
this.field('abstract');
|
28
|
+
for (const [url, doc] of Object.entries(searchData)) {
|
29
|
+
this.add({url: url, name: doc.name, abstract: doc.abstract});
|
30
|
+
}
|
31
|
+
});
|
32
|
+
|
33
|
+
$typeahead.typeahead(
|
34
|
+
{
|
35
|
+
highlight: true,
|
36
|
+
minLength: 3,
|
37
|
+
autoselect: true
|
38
|
+
},
|
39
|
+
{
|
40
|
+
limit: 10,
|
41
|
+
display: displayTemplate,
|
42
|
+
templates: { suggestion: suggestionTemplate },
|
43
|
+
source: function(query, sync) {
|
44
|
+
const lcSearch = query.toLowerCase();
|
45
|
+
const results = searchIndex.query(function(q) {
|
46
|
+
q.term(lcSearch, { boost: 100 });
|
47
|
+
q.term(lcSearch, {
|
48
|
+
boost: 10,
|
49
|
+
wildcard: lunr.Query.wildcard.TRAILING
|
50
|
+
});
|
51
|
+
}).map(function(result) {
|
52
|
+
var doc = searchData[result.ref];
|
53
|
+
doc.url = result.ref;
|
54
|
+
return doc;
|
55
|
+
});
|
56
|
+
sync(results);
|
57
|
+
}
|
58
|
+
}
|
59
|
+
);
|
60
|
+
$form.removeClass('loading');
|
61
|
+
$typeahead.trigger('focus');
|
62
|
+
});
|
63
|
+
});
|
64
|
+
|
65
|
+
var baseURL = searchURL.slice(0, -"search.json".length);
|
66
|
+
|
67
|
+
$typeahead.on('typeahead:select', function(e, result) {
|
68
|
+
window.location = baseURL + result.url;
|
69
|
+
});
|
70
|
+
});
|