Skip to content

Commit 7468f0c

Browse files
flovilmartflovilmart
authored
Merge pull request #388 from hramos/algolia
Add support for Algolia DocSearch
2 parents eb19cae + 2a14004 commit 7468f0c

File tree

25 files changed

+316
-107
lines changed

25 files changed

+316
-107
lines changed

‎_includes/head.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<head>
22
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
33

4-
<title>{{ page.platform }} Developers Guide | Parse</title>
4+
<title>{{ page.title }}</title>
55

66
<link rel="apple-touch-icon" sizes="57x57" href="https://parse.com/apple-touch-icon-57x57.png">
77
<link rel="apple-touch-icon" sizes="114x114" href="https://parse.com/apple-touch-icon-114x114.png">
@@ -28,6 +28,7 @@
2828
<!-- build:css -->
2929
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/styles/default.min.css">
3030
<link href="{{ site.baseurl }}/css/docs.css" rel="stylesheet" />
31+
<link href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" rel="stylesheet" />
3132
<!-- endbuild -->
3233

3334
<!--[if lte IE 9]>

‎_layouts/guide.html

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@
99
{% include menu.html %}
1010
<div class="content__wrapper">
1111
{% include header.html %}
12-
1312
<aside class="hero hero--docs {{ '_docs_header' | prepend: page.platform | downcase }}">
1413
<div class="grid-container">
1514
<div class="col-md--6 col-lg--9">
16-
<p class="h1 h1--white" data-ignore-from-select>
17-
<span>{{ page.platform }} <em>Guide</em></span>
15+
<p class="h1 h1--white" data-ignore-from-select>
16+
<span>{{ page.display_platform }} <em>Guide</em></span>
17+
18+
<a href="/docs/" class="btn btn--back">
19+
<span class="hide-mobile">Browse all platforms</span>
20+
<span class="show-mobile">Browse</span>
21+
</a>
1822

19-
<a href="/docs/" class="btn btn--back">
20-
<span class="hide-mobile">Browse all platforms</span>
21-
<span class="show-mobile">Browse</span>
22-
</a>
23+
<svg class="icon icon-{{ page.platform | downcase }}"><use xlink:href="{{ site.baseurl }}/assets/symbols.svg#{{ page.platform | downcase }}"></use></svg>
2324

24-
<svg class="icon icon-{{ page.platform | downcase }}"><use xlink:href="{{ site.baseurl }}/assets/symbols.svg#{{ page.platform | downcase }}"></use></svg>
25-
</p>
25+
</p>
2626
</div>
2727
</div>
2828
</aside><!-- .hero -->
@@ -34,19 +34,24 @@
3434

3535
<div class="grid-container">
3636
<div class="col-md--6 col-lg--9">
37-
3837
<div class="guide_content">
39-
<div id="toc" style="overflow-y: scroll; height: 100%;">
40-
<div class="top_links">
41-
{% if page.quickstart %}
42-
<a href="{{ page.quickstart }}">Quickstart<i class="icon_minimize"></i></a>
43-
{% endif %}
44-
{% if page.guide %}
45-
<a href="{{ page.guide }}">Guide<i class="icon_minimize"></i></a>
46-
{% endif %}
47-
{% if page.api_reference %}
48-
<a href="{{ page.api_reference }}">API Reference<i class="icon_minimize"></i></a>
49-
{% endif %}
38+
<div id="toc">
39+
<div style="overflow-y: scroll; height: 100%;">
40+
<div class="top_links">
41+
{% if page.quickstart %}
42+
<a href="{{ page.quickstart }}">Quickstart<i class="icon_minimize"></i></a>
43+
{% endif %}
44+
{% if page.guide %}
45+
<a href="{{ page.guide }}">Guide<i class="icon_minimize"></i></a>
46+
{% endif %}
47+
{% if page.api_reference %}
48+
<a href="{{ page.api_reference }}">API Reference<i class="icon_minimize"></i></a>
49+
{% endif %}
50+
<!-- .algolia-search-wrapper -->
51+
<div class="algolia-search-wrapper">
52+
<input id="algolia-doc-search" class="{{ '_docs_docsearch' | prepend: page.platform | downcase }}" tabindex="0" type="text" placeholder="Search..." />
53+
</div><!-- .algolia-search-wrapper -->
54+
</div>
5055
</div>
5156
</div>
5257

@@ -70,4 +75,13 @@
7075

7176
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/highlight.min.js"></script>
7277
<script src="{{ site.baseurl }}/assets/js/bundle.js"></script>
78+
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
79+
<script type="text/javascript"> docsearch({
80+
apiKey: 'c7f5661ba53e2e3c1c3752696362209e',
81+
indexName: 'parse',
82+
inputSelector: '#algolia-doc-search',
83+
algoliaOptions: { 'facetFilters': ["tags:{{ page.platform | downcase }}"] }, // android, arduino, cloudcode, dotnet, embedded_c, ios, js, macos, parse-server, php, rest, unity
84+
debug: false // Set debug to true if you want to inspect the dropdown
85+
});
86+
</script>
7387
</body>

‎_site/android/guide/index.html

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
<!-- build:css -->
3131
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/styles/default.min.css">
3232
<link href="/docs/css/docs.css" rel="stylesheet" />
33+
<link href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" rel="stylesheet" />
3334
<!-- endbuild -->
3435

3536
<!--[if lte IE 9]>
@@ -174,20 +175,20 @@ <h4 class="h4">Stay Connected</h4>
174175
</div><!-- container -->
175176
</header>
176177

177-
178178
<aside class="hero hero--docs android_docs_header">
179179
<div class="grid-container">
180180
<div class="col-md--6 col-lg--9">
181-
<p class="h1 h1--white" data-ignore-from-select>
182-
<span>Android <em>Guide</em></span>
181+
<p class="h1 h1--white" data-ignore-from-select>
182+
<span>Android <em>Guide</em></span>
183+
184+
<a href="/docs/" class="btn btn--back">
185+
<span class="hide-mobile">Browse all platforms</span>
186+
<span class="show-mobile">Browse</span>
187+
</a>
183188

184-
<a href="/docs/" class="btn btn--back">
185-
<span class="hide-mobile">Browse all platforms</span>
186-
<span class="show-mobile">Browse</span>
187-
</a>
189+
<svg class="icon icon-android"><use xlink:href="/docs/assets/symbols.svg#android"></use></svg>
188190

189-
<svg class="icon icon-android"><use xlink:href="/docs/assets/symbols.svg#android"></use></svg>
190-
</p>
191+
</p>
191192
</div>
192193
</div>
193194
</aside><!-- .hero -->
@@ -199,17 +200,22 @@ <h4 class="h4">Stay Connected</h4>
199200

200201
<div class="grid-container">
201202
<div class="col-md--6 col-lg--9">
202-
203203
<div class="guide_content">
204-
<div id="toc" style="overflow-y: scroll; height: 100%;">
205-
<div class="top_links">
206-
207-
<a href="https://parse.com/apps/quickstart">Quickstart<i class="icon_minimize"></i></a>
208-
209-
210-
211-
<a href="https://parseplatform.github.io/Parse-SDK-Android/api">API Reference<i class="icon_minimize"></i></a>
212-
204+
<div id="toc">
205+
<div style="overflow-y: scroll; height: 100%;">
206+
<div class="top_links">
207+
208+
<a href="https://parse.com/apps/quickstart">Quickstart<i class="icon_minimize"></i></a>
209+
210+
211+
212+
<a href="https://parseplatform.github.io/Parse-SDK-Android/api">API Reference<i class="icon_minimize"></i></a>
213+
214+
<!-- .algolia-search-wrapper -->
215+
<div class="algolia-search-wrapper">
216+
<input id="algolia-doc-search" class="android_docs_docsearch" tabindex="0" type="text" placeholder="Search..." />
217+
</div><!-- .algolia-search-wrapper -->
218+
</div>
213219
</div>
214220
</div>
215221

@@ -7434,6 +7440,15 @@ <h2 id="other-issues">Other issues</h2>
74347440

74357441
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/highlight.min.js"></script>
74367442
<script src="/docs/assets/js/bundle.js"></script>
7443+
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
7444+
<script type="text/javascript"> docsearch({
7445+
apiKey: 'c7f5661ba53e2e3c1c3752696362209e',
7446+
indexName: 'parse',
7447+
inputSelector: '#algolia-doc-search',
7448+
algoliaOptions: { 'facetFilters': ["tags:android"] }, // android, arduino, cloudcode, dotnet, embedded_c, ios, js, macos, parse-server, php, rest, unity
7449+
debug: false // Set debug to true if you want to inspect the dropdown
7450+
});
7451+
</script>
74377452
</body>
74387453

74397454
</html>

‎_site/css/docs.css

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -730,9 +730,9 @@ input[type="text"]:focus::placeholder { color: rgba(102, 99, 122, 0.2); }
730730
.banner-cta--tall .h2 { color: white; }
731731
.banner-cta--gray { background-color: #f5f5f8; }
732732

733-
#toc { display: none; position: absolute; left: 0; top: 0; padding-top: 45px; padding-bottom: 45px; width: 174px; transition: padding-top 200ms ease-in; }
733+
#toc { display: none; position: absolute; left: 0; top: 0; padding-top: 85px; padding-bottom: 85px; width: 174px; transition: padding-top 200ms ease-in; }
734734
#toc a { display: block; }
735-
#toc.is-fixed { padding-top: 80px; position: fixed; height: 100%; overflow: auto; }
735+
#toc.is-fixed { padding-top: 120px; position: fixed; height: 100%; overflow: auto; }
736736
#toc .top_links { margin-bottom: 15px; }
737737
#toc .top_links a { display: block; padding: 3px 0; font-family: "webfont_alright"; font-weight: 300; font-size: 1.6rem; color: #8F8F8F; }
738738
#toc .top_links a:after { content: ""; display: inline-block; margin-left: 5px; width: 15px; height: 13px; }
@@ -798,6 +798,41 @@ html.no-touch .docs-platform .btn:hover { background-color: #169CEE; color: whit
798798
.docs-platform header:not(.hasversion) .docs-platform__name { padding-top: 9px; }
799799
.docs-platform span.spacer { position: relative; display: block; text-decoration: none; padding: 13px 16px 11px; border-left: 1px solid #E0E0EA; border-right: 1px solid #E0E0EA; font-size: 1.4rem; transition: background-color 150ms ease; height: 41px; }
800800

801+
div.algolia-search-wrapper { display: inline-block; vertical-align: top; position: absolute; top: 20px; left: 0; }
802+
803+
.algolia-autocomplete .aa-dropdown-menu { margin-left: -210px; margin-top: -4px; }
804+
805+
@media screen and (max-width: 960px) { div.algolia-search-wrapper { display: none; } }
806+
input#algolia-doc-search { background: transparent url("/docs/assets/images/search.png") no-repeat 10px center; background-size: 16px 16px; padding: 0 10px; padding-left: 35px; margin-top: 10px; height: 30px; font-size: 16px; line-height: 20px; background-color: #555; border-radius: 4px; color: white; outline: none; border: none; width: 170px; transition: .5s width ease; -webkit-transition: .5s width ease; -moz-transition: .5s width ease; -o-transition: .5s width ease; }
807+
input#algolia-doc-search::placeholder { color: white; }
808+
input#algolia-doc-search::-webkit-input-placeholder { color: white; }
809+
input#algolia-doc-search::-moz-placeholder { color: white; }
810+
input#algolia-doc-search:-ms-input-placeholder { color: white; }
811+
input#algolia-doc-search:-moz-placeholder { color: white; }
812+
input#algolia-doc-search.ios_docs_docsearch { background-color: #5B707D; }
813+
input#algolia-doc-search.android_docs_docsearch { background-color: #00C26E; }
814+
input#algolia-doc-search.cloudcode_docs_docsearch { background-color: #169CEE; }
815+
input#algolia-doc-search.js_docs_docsearch { background-color: #F5A623; }
816+
input#algolia-doc-search.osx_docs_docsearch { background-color: #9CAFBA; }
817+
input#algolia-doc-search.unity_docs_docsearch { background-color: #11A4BA; }
818+
input#algolia-doc-search.php_docs_docsearch { background-color: #0E69A1; }
819+
input#algolia-doc-search.dotnet_docs_docsearch { background-color: #922ADD; }
820+
input#algolia-doc-search.arduino_docs_docsearch { background-color: #169CEE; }
821+
input#algolia-doc-search.embedded_c_docs_docsearch { background-color: #15D0ED; }
822+
input#algolia-doc-search.rest_docs_docsearch { background-color: #FF395E; }
823+
input#algolia-doc-search:focus { width: 300px; }
824+
825+
.algolia-autocomplete { vertical-align: top; height: 53px; }
826+
827+
.algolia-docsearch-suggestion { border-bottom-color: #e0f6ff; }
828+
.algolia-docsearch-suggestion--category-header { background-color: white; }
829+
.algolia-docsearch-suggestion--highlight { color: #169CEE; }
830+
.algolia-docsearch-suggestion--category-header, .algolia-docsearch-suggestion--highlight { background-color: #169CEE; }
831+
.algolia-docsearch-suggestion--subcategory-column { border-right-color: #e0f6ff; background-color: #ebf9ff; color: #3B3738; }
832+
833+
.aa-cursor .algolia-docsearch-suggestion { background: #ebf9ff; }
834+
.aa-cursor .algolia-docsearch-suggestion--content { color: #169CEE; }
835+
801836
.logo-stack { *zoom: 1; padding: 28px 0; border-top: 1px solid rgba(216, 216, 216, 0.4); }
802837
.logo-stacks { *zoom: 1; }
803838
.logo-stacks:before, .logo-stacks:after { content: " "; display: table; }
@@ -823,7 +858,7 @@ html.no-touch .docs-platform .btn:hover { background-color: #169CEE; color: whit
823858
.logo-stack--purple .logo-stack__icon { background-color: #3B2C48; }
824859
.logo-stack--purple .logo-stack__list a { color: #3B2C48; }
825860

826-
.p_docs .guide_content { position: relative; padding: 30px 0 0 0; }
861+
.p_docs .guide_content { position: relative; padding: 75px 0 0 0; }
827862
@media (min-width: 760px) { .p_docs .guide_content { padding-left: 210px; } }
828863
@media (min-width: 1104px) { .p_docs .guide_content { padding-left: 230px; padding-right: 270px; } }
829864
.p_docs .guide_content .helpful { color: #66637A; font-size: 1.2rem; margin: 2em 0 5em; }

‎_site/ios/guide/index.html

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
<!-- build:css -->
3131
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/styles/default.min.css">
3232
<link href="/docs/css/docs.css" rel="stylesheet" />
33+
<link href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" rel="stylesheet" />
3334
<!-- endbuild -->
3435

3536
<!--[if lte IE 9]>
@@ -174,20 +175,20 @@ <h4 class="h4">Stay Connected</h4>
174175
</div><!-- container -->
175176
</header>
176177

177-
178178
<aside class="hero hero--docs ios_docs_header">
179179
<div class="grid-container">
180180
<div class="col-md--6 col-lg--9">
181-
<p class="h1 h1--white" data-ignore-from-select>
182-
<span>iOS <em>Guide</em></span>
181+
<p class="h1 h1--white" data-ignore-from-select>
182+
<span>iOS <em>Guide</em></span>
183+
184+
<a href="/docs/" class="btn btn--back">
185+
<span class="hide-mobile">Browse all platforms</span>
186+
<span class="show-mobile">Browse</span>
187+
</a>
183188

184-
<a href="/docs/" class="btn btn--back">
185-
<span class="hide-mobile">Browse all platforms</span>
186-
<span class="show-mobile">Browse</span>
187-
</a>
189+
<svg class="icon icon-ios"><use xlink:href="/docs/assets/symbols.svg#ios"></use></svg>
188190

189-
<svg class="icon icon-ios"><use xlink:href="/docs/assets/symbols.svg#ios"></use></svg>
190-
</p>
191+
</p>
191192
</div>
192193
</div>
193194
</aside><!-- .hero -->
@@ -199,17 +200,22 @@ <h4 class="h4">Stay Connected</h4>
199200

200201
<div class="grid-container">
201202
<div class="col-md--6 col-lg--9">
202-
203203
<div class="guide_content">
204-
<div id="toc" style="overflow-y: scroll; height: 100%;">
205-
<div class="top_links">
206-
207-
<a href="https://parse.com/apps/quickstart">Quickstart<i class="icon_minimize"></i></a>
208-
209-
210-
211-
<a href="https://parseplatform.github.io/Parse-SDK-iOS-OSX/api">API Reference<i class="icon_minimize"></i></a>
212-
204+
<div id="toc">
205+
<div style="overflow-y: scroll; height: 100%;">
206+
<div class="top_links">
207+
208+
<a href="https://parse.com/apps/quickstart">Quickstart<i class="icon_minimize"></i></a>
209+
210+
211+
212+
<a href="https://parseplatform.github.io/Parse-SDK-iOS-OSX/api">API Reference<i class="icon_minimize"></i></a>
213+
214+
<!-- .algolia-search-wrapper -->
215+
<div class="algolia-search-wrapper">
216+
<input id="algolia-doc-search" class="ios_docs_docsearch" tabindex="0" type="text" placeholder="Search..." />
217+
</div><!-- .algolia-search-wrapper -->
218+
</div>
213219
</div>
214220
</div>
215221

@@ -10033,6 +10039,15 @@ <h2 id="other-issues">Other issues</h2>
1003310039

1003410040
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.5.0/highlight.min.js"></script>
1003510041
<script src="/docs/assets/js/bundle.js"></script>
10042+
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
10043+
<script type="text/javascript"> docsearch({
10044+
apiKey: 'c7f5661ba53e2e3c1c3752696362209e',
10045+
indexName: 'parse',
10046+
inputSelector: '#algolia-doc-search',
10047+
algoliaOptions: { 'facetFilters': ["tags:ios"] }, // android, arduino, cloudcode, dotnet, embedded_c, ios, js, macos, parse-server, php, rest, unity
10048+
debug: false // Set debug to true if you want to inspect the dropdown
10049+
});
10050+
</script>
1003610051
</body>
1003710052

1003810053
</html>

‎android.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: Android Developers Guide | Parse
33
permalink: /android/guide/
44
layout: guide
5-
platform: Android
5+
platform: android
6+
display_platform: Android
67
quickstart: https://parse.com/apps/quickstart
78
api_reference: https://parseplatform.github.io/Parse-SDK-Android/api
89

‎arduino.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: Arduino Developers Guide | Parse
33
permalink: /arduino/guide/
44
layout: guide
5-
platform: Arduino
5+
platform: arduino
6+
display_platform: Arduino
67
quickstart: https://parse.com/apps/quickstart
78
api_reference: https://parseplatform.github.io/Parse-SDK-Arduino/api
89

‎assets/images/search.png

1.35 KB
Loading

0 commit comments

Comments
 (0)