Skip to content
This repository was archived by the owner on Jan 30, 2024. It is now read-only.

Commit 90af7bf

Browse files
KieranHayesKieranHayes
authored
Merge pull request #16 from KieranHayes/feature/add_algolia_search
Feature/add algolia search
2 parents 014da8f + 0eac7f2 commit 90af7bf

File tree

16 files changed

+532
-39
lines changed

16 files changed

+532
-39
lines changed

‎Gemfile‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
source 'https://rubygems.org'
2-
gem 'github-pages', group: :jekyll_plugins
2+
group :jekyll_plugins do
3+
gem 'github-pages'
4+
gem 'algoliasearch-jekyll', '~> 0.8.0'
5+
end

‎Gemfile.lock‎

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,64 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
activesupport (5.0.0)
5-
concurrent-ruby (~> 1.0, >= 1.0.2)
4+
activesupport (4.2.7)
65
i18n (~> 0.7)
6+
json (~> 1.7, >= 1.7.7)
77
minitest (~> 5.1)
8+
thread_safe (~> 0.3, >= 0.3.4)
89
tzinfo (~> 1.1)
910
addressable (2.4.0)
11+
algoliasearch (1.11.0)
12+
httpclient (~> 2.8.2)
13+
json (>= 1.5.1)
14+
algoliasearch-jekyll (0.8.0)
15+
algoliasearch (~> 1.4)
16+
appraisal (~> 2.1.0)
17+
awesome_print (~> 1.6)
18+
json (~> 1.8)
19+
nokogiri (~> 1.6)
20+
verbal_expressions (~> 0.1.5)
21+
appraisal (2.1.0)
22+
bundler
23+
rake
24+
thor (>= 0.14.0)
25+
awesome_print (1.7.0)
1026
coffee-script (2.4.1)
1127
coffee-script-source
1228
execjs
1329
coffee-script-source (1.10.0)
14-
colorator (0.1)
15-
concurrent-ruby (1.0.2)
30+
colorator (1.1.0)
1631
ethon (0.9.0)
1732
ffi (>= 1.3.0)
1833
execjs (2.7.0)
1934
faraday (0.9.2)
2035
multipart-post (>= 1.2, < 3)
2136
ffi (1.9.14)
37+
forwardable-extended (2.6.0)
2238
gemoji (2.1.0)
23-
github-pages (87)
24-
github-pages-health-check (= 1.1.0)
25-
jekyll (= 3.1.6)
39+
github-pages (96)
40+
activesupport (= 4.2.7)
41+
github-pages-health-check (= 1.2.0)
42+
jekyll (= 3.2.1)
2643
jekyll-coffeescript (= 1.0.1)
2744
jekyll-feed (= 0.5.1)
2845
jekyll-gist (= 1.4.0)
2946
jekyll-github-metadata (= 2.0.2)
30-
jekyll-mentions (= 1.1.3)
47+
jekyll-mentions (= 1.2.0)
3148
jekyll-paginate (= 1.1.0)
3249
jekyll-redirect-from (= 0.11.0)
3350
jekyll-sass-converter (= 1.3.0)
3451
jekyll-seo-tag (= 2.0.0)
3552
jekyll-sitemap (= 0.10.0)
36-
jemoji (= 0.6.2)
53+
jemoji (= 0.7.0)
3754
kramdown (= 1.11.1)
3855
liquid (= 3.0.6)
3956
listen (= 3.0.6)
4057
mercenary (~> 0.3)
58+
minima (= 1.2.0)
4159
rouge (= 1.11.1)
4260
terminal-table (~> 1.4)
43-
github-pages-health-check (1.1.0)
61+
github-pages-health-check (1.2.0)
4462
addressable (~> 2.3)
4563
net-dns (~> 0.8)
4664
octokit (~> 4.0)
@@ -49,14 +67,16 @@ GEM
4967
html-pipeline (2.4.2)
5068
activesupport (>= 2)
5169
nokogiri (>= 1.4)
70+
httpclient (2.8.2.4)
5271
i18n (0.7.0)
53-
jekyll (3.1.6)
54-
colorator (~> 0.1)
72+
jekyll (3.2.1)
73+
colorator (~> 1.0)
5574
jekyll-sass-converter (~> 1.0)
5675
jekyll-watch (~> 1.1)
5776
kramdown (~> 1.3)
5877
liquid (~> 3.0)
5978
mercenary (~> 0.3.3)
79+
pathutil (~> 0.9)
6080
rouge (~> 1.7)
6181
safe_yaml (~> 1.0)
6282
jekyll-coffeescript (1.0.1)
@@ -67,7 +87,8 @@ GEM
6787
jekyll-github-metadata (2.0.2)
6888
jekyll (~> 3.1)
6989
octokit (~> 4.0)
70-
jekyll-mentions (1.1.3)
90+
jekyll-mentions (1.2.0)
91+
activesupport (~> 4.0)
7192
html-pipeline (~> 2.3)
7293
jekyll (~> 3.0)
7394
jekyll-paginate (1.1.0)
@@ -78,19 +99,22 @@ GEM
7899
jekyll-seo-tag (2.0.0)
79100
jekyll (~> 3.1)
80101
jekyll-sitemap (0.10.0)
81-
jekyll-watch (1.4.0)
102+
jekyll-watch (1.5.0)
82103
listen (~> 3.0, < 3.1)
83-
jemoji (0.6.2)
104+
jemoji (0.7.0)
105+
activesupport (~> 4.0)
84106
gemoji (~> 2.0)
85107
html-pipeline (~> 2.2)
86108
jekyll (>= 3.0)
109+
json (1.8.3)
87110
kramdown (1.11.1)
88111
liquid (3.0.6)
89112
listen (3.0.6)
90113
rb-fsevent (>= 0.9.3)
91114
rb-inotify (>= 0.9.7)
92115
mercenary (0.3.6)
93116
mini_portile2 (2.1.0)
117+
minima (1.2.0)
94118
minitest (5.9.0)
95119
multipart-post (2.0.0)
96120
net-dns (0.8.0)
@@ -99,8 +123,11 @@ GEM
99123
pkg-config (~> 1.1.7)
100124
octokit (4.3.0)
101125
sawyer (~> 0.7.0, >= 0.5.3)
126+
pathutil (0.14.0)
127+
forwardable-extended (~> 2.6)
102128
pkg-config (1.1.7)
103129
public_suffix (1.5.3)
130+
rake (11.2.2)
104131
rb-fsevent (0.9.7)
105132
rb-inotify (0.9.7)
106133
ffi (>= 0.5.0)
@@ -110,17 +137,22 @@ GEM
110137
sawyer (0.7.0)
111138
addressable (>= 2.3.5, < 2.5)
112139
faraday (~> 0.8, < 0.10)
113-
terminal-table (1.6.0)
140+
terminal-table (1.7.2)
141+
unicode-display_width (~> 1.1.1)
142+
thor (0.19.1)
114143
thread_safe (0.3.5)
115144
typhoeus (0.8.0)
116145
ethon (>= 0.8.0)
117146
tzinfo (1.2.2)
118147
thread_safe (~> 0.1)
148+
unicode-display_width (1.1.1)
149+
verbal_expressions (0.1.5)
119150

120151
PLATFORMS
121152
ruby
122153

123154
DEPENDENCIES
155+
algoliasearch-jekyll (~> 0.8.0)
124156
github-pages
125157

126158
BUNDLED WITH

‎_config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,7 @@ github_username: dkdeploy
1616
exclude: [foundation, vendor]
1717
# Build settings
1818
markdown: kramdown
19+
algolia:
20+
application_id: 'QOFNLOOCWH'
21+
index_name: 'dkdeploy_production'
22+
record_css_selector: 'p,ul,td,th,h3,code'

‎_includes/footer.html‎

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,50 @@
22
<div class="row">
33
<div class="large-12 columns">
44
<div class="footer-content">
5-
<p>&copy 2016 <a href="https:/www.dkd.de/">dkd Internet Service GmbH</a> <i class="fi-heart animated"></i> <a href="mailto:opensource@dkd.de">opensource@dkd.de</a></p>
5+
<p>&copy; 2016 <a href="https://www.dkd.de/">dkd Internet Service GmbH</a> <i class="fi-heart animated"></i> <a href="mailto:opensource@dkd.de">opensource@dkd.de</a></p>
66
</div>
77
</div>
88
</div>
99
</footer>
10+
<script>
11+
window.ALGOLIA_CONFIG = {
12+
'applicationId': 'QOFNLOOCWH',
13+
'indexName': 'dkdeploy_production',
14+
'apiKey': 'e51022a00302b50ec0f0fe226c460d5e',
15+
'baseurl': ''
16+
}
17+
</script>
18+
<script id="algolia__template" type="text/template">
19+
{% raw %}
20+
<div class="algolia__result">
21+
<a class="algolia__result-link" href="{{ full_url }}#algolia:{{ css_selector }}">{{{ _highlightResult.title.value }}}</a>
22+
{{#posted_at}}
23+
<div class="algolia__result-date">{{ posted_at_readable }}</div>
24+
{{/posted_at}}
25+
<div class="algolia__result-text">{{{ _highlightResult.text.value }}}</div>
26+
</div>
27+
{% endraw %}
28+
</script>
1029
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.0/jquery.min.js"></script>
1130
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/foundation/6.2.3/foundation.min.js" defer></script>
31+
<script src="//cdn.jsdelivr.net/algoliasearch/3.6.0/algoliasearch.min.js"></script>
32+
<script src="//cdn.jsdelivr.net/algoliasearch.helper/2.1.0/algoliasearch.helper.min.js"></script>
33+
<script src="//cdn.jsdelivr.net/hogan.js/3.0.2/hogan.min.js"></script>
34+
<script src="//cdn.jsdelivr.net/momentjs/2.10.3/moment.min.js"></script>
35+
<script src="{{ site.baseurl }}/assets/javascript/algolia.js"></script>
36+
<script src="https://use.fontawesome.com/b5dbc25dd5.js"></script>
1237
<script type="text/javascript" src="{{ '/assets/javascript/toc2select.js' | prepend: site.url }}" defer></script>
1338
<script type="text/javascript">
1439
$(document).ready(function(){
1540
$(document).foundation();
16-
var toc2select = new DkdeployApp.Classes.toc2select("#main-content", "#js-toc", "<span class='toc-label'>Jump to</span>");
41+
var toc2select = new DkdeployApp.Classes.toc2select("#main-content", "#js-toc", '<span class="input-group-label"><i class="fa fa-anchor" aria-hidden="true"></i></span>');
1742
toc2select.render()
43+
44+
// Search
45+
$('.input-group-algolia input').on('focus', function(){
46+
$('.input-group-algolia').addClass("input-group-algolia-focus");
47+
}).on('focusout', function(){
48+
$('.input-group-algolia').removeClass('input-group-algolia-focus');
49+
});
1850
})
1951
</script>

‎_includes/head.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22
<meta charset="utf-8">
33
<meta http-equiv="X-UA-Compatible" content="IE=edge">
44
<meta name="viewport" content="width=device-width, initial-scale=1">
5-
65
<title>dkdeploy | {% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
76
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
8-
<link rel="stylesheet" href="{{ "/assets/css/app.css" | prepend: site.url }}">
7+
<link rel="stylesheet" href="{{ "/assets/css/app.css" | prepend: site.url }}">
98
<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
109
</head>

‎_includes/header.html‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,31 @@
1919
{% endfor %}
2020
</ul>
2121
</div>
22-
<div class="top-bar-right" id="js-toc"></div>
22+
<div class="top-bar-right">
23+
<ul class="menu">
24+
<li>
25+
<div class="input-group" id="js-toc">
26+
</div>
27+
</li>
28+
</ul>
29+
</div>
30+
<div class="top-bar-right">
31+
<ul class="menu">
32+
<li>
33+
<div class="input-group input-group-algolia">
34+
<span class="input-group-label"><i class="fa fa-search" aria-hidden="true"></i>
35+
</span>
36+
<input type="text" class="algolia__input js-algolia__input" autocomplete="off" name="query" placeholder="Search ..." />
37+
</div>
38+
</li>
39+
</ul>
40+
</div>
41+
2342
</div>
2443
</div>
2544
</div> <!-- end sticky-container -->
2645
<ul id="mobile-navigation" class="hide-for-medium vertical menu" data-responsive-menu="small-dropdown">
27-
<li class="menu-text"><a href="/"><img style="height: 24px; margin-left: -17px" src="/assets/images/3056-73126-dkdeploy-logo.svg"></a></li>
46+
<li class="menu-text"><a href="/"><img class="logo" alt="dkdeploy" title="dkdeploy" src="/assets/images/3056-73126-dkdeploy-logo.svg"></a></li>
2847
{% for nav in site.data.navigation %}
2948
{% if page.section == nav.section %}
3049
{% assign active = "active" %}

‎_layouts/default.html‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@
55
<div id="content" class="row">
66
{% include header.html %}
77
<div class="large-3 sidebar columns">
8-
98
<ul class="vertical menu docs-menu nav1">
109
{% assign current_path = page.url %}
11-
1210
{% for nav in site.data.navigation %}
1311
{% if page.section == nav.section %}
1412
{% capture current_nav %}{{nav.href}}{% endcapture %}
@@ -17,7 +15,6 @@
1715
{% else %}
1816
{% assign active = "" %}
1917
{% endif %}
20-
2118
<li class="docs-menu-title {{active}}">
2219
<a href="{{nav.href}}">{{nav.title}}</a>
2320
{% if nav.subnav2 != empty %}
@@ -31,7 +28,11 @@
3128
</ul>
3229
</div>
3330
<div id="main-content" class="large-9 main-content columns">
34-
{{ content }}
31+
<div class="algolia__initial-content js-algolia__initial-content">{{ content }}</div>
32+
<div class="algolia__search-content js-algolia__search-content">
33+
<h3 class="page-title algolia">Search Results <span>powered by <a href="https://algolia.com/"><img alt="Algolia Search" title="Algolia Search" src="/assets/images/Algolia_logo_bg-white.svg"></a></span></h3>
34+
<div class="posts algolia__results"></div>
35+
</div>
3536
</div>
3637
</div>
3738
{% include footer.html %}

‎_layouts/startpage.html‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
<!DOCTYPE html>
22
<html>
33
{% include head.html %}
4-
<body style="" class="startpage">
4+
<body class="startpage">
55
<div id="content" class="row">
66
{% include header.html %}
77
<div id="startpage-container" class="row hero-cards" data-equalize-on="large" data-equalizer>
88
<div class="large-4 columns card-1" >
99
<div class="inner" data-equalizer-watch>
1010
<h3>Extended functionality</h3>
11-
<p>Beside all the great functionalities Capistrano provides out of the box, <b>dkdeploy</b> gives you
11+
<p>Beside all the great functionalities Capistrano provides out of the box, <b>dkdeploy</b> gives you </p>
1212
<ul>
1313
<li>Granular file permissions</li>
1414
<li>an extended Rollback Manager</li>
1515
<li>a Maintenance page during deployment</li>
1616
<li>a Copy strategy like on Capistrano 2.x</li>
1717
<li>Bower Integration</li>
1818
</ul>... and many more great features.
19-
</p>
2019
</div>
2120
</div>
2221
<div class="large-4 columns card-2">
@@ -40,12 +39,6 @@ <h3>PHP Ready!</h3>
4039
</div>
4140
</div>
4241
</div>
43-
<div style="display: none">
44-
{{ content }}
45-
</div>
4642
{% include footer.html %}
47-
</div>
48-
4943
</body>
50-
5144
</html>

0 commit comments

Comments
 (0)