You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by sarangan12 <gi...@git.apache.org> on 2016/04/18 21:24:30 UTC
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
GitHub user sarangan12 opened a pull request:
https://github.com/apache/cordova-docs/pull/581
CB-11104: Integrate Algolia Search to cordova docs
@nikhilkh @dblotsky @riknoll @rakatyal Could you please review this PR?
Note: Please do NOT merge this PR now.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/sarangan12/cordova-docs AlgoilaSearchIntegration
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-docs/pull/581.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #581
----
commit e7590ad05392399995be495c4613e0c5aabda34e
Author: Sarangan Rajamanickam <sa...@microsoft.com>
Date: 2016-04-18T19:19:05Z
CB-11104: Integrate Algolia Search to cordova docs
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60329745
--- Diff: conf/_config.yml ---
@@ -81,3 +81,5 @@ kramdown:
# exclude these directories from the build
exclude:
- static/css-src
+
+algolia_api_key: "0a916ab198bd93d031aa70611271e42e"
--- End diff --
:-)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60328488
--- Diff: www/static/css-src/main.scss ---
@@ -194,6 +194,23 @@ code {
color: #000000;
}
+/* algolia search formatting */
+.algolia-docsearch-suggestion--category-header, .algolia-docsearch-suggestion {
+ font-family: "Raleway", Helvetica, Arial, sans-serif;
+}
--- End diff --
The value are overridden in the Algolia CSS file.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60677936
--- Diff: www/static/js/algolia.js ---
@@ -0,0 +1,21 @@
+---
+---
+
+{% if page.version %}
+ {% assign version = page.version %}
+{% else %}
+ {% assign version = site.latest_docs_version %}
+{% endif %}
+
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+docsearch({
+ apiKey: '{{ site.algolia_api_key }}',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': ["version: {{ version }}", "language: {{ language }}"] }
--- End diff --
Two notes:
- in the example from the Algolia folks, I think there was no space between `version:` and `{{version}}`; same for the language
- the two variables need to be generated as constants on the HTML page (maybe bring back `algolia.html` include) and then used in this file
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60314159
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,27 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+ <script type="text/javascript">
+ docsearch({
+ apiKey: '0a916ab198bd93d031aa70611271e42e',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': [ "version:6.x","language: {{ language }}" ] }
+ });
+ </script>
--- End diff --
Also, please place this code into an include like `analytics.html` for consistency.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60329685
--- Diff: www/_includes/algolia.html ---
@@ -0,0 +1,14 @@
+{% if page.version %}
+ {% assign version = page.version %}
+{% else %}
+ {% assign version = site.latest_docs_version %}
+{% endif %}
+
+<script type="text/javascript">
+ docsearch({
+ apiKey: '{{ site.algolia_api_key }}',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': ["version: {{ version }}", "language: {{ language }}"] }
--- End diff --
Fixed
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60328452
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,27 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+ <script type="text/javascript">
+ docsearch({
+ apiKey: '0a916ab198bd93d031aa70611271e42e',
--- End diff --
Done
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60312938
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,27 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+ <script type="text/javascript">
+ docsearch({
+ apiKey: '0a916ab198bd93d031aa70611271e42e',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': [ "version:6.x","language: {{ language }}" ] }
+ });
+ </script>
--- End diff --
Please fix the indentation for this block. It's offset by one space.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60313002
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,27 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+ <script type="text/javascript">
+ docsearch({
+ apiKey: '0a916ab198bd93d031aa70611271e42e',
--- End diff --
Please put this value in `_config.yml`.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on the pull request:
https://github.com/apache/cordova-docs/pull/581#issuecomment-212170562
@dblotsky Let me know when you are done... I will merge the commits to one commit.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60329672
--- Diff: conf/_config.yml ---
@@ -81,3 +81,5 @@ kramdown:
# exclude these directories from the build
exclude:
- static/css-src
+
+algolia_api_key: "0a916ab198bd93d031aa70611271e42e"
--- End diff --
:-)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/cordova-docs/pull/581
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60329201
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,20 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
--- End diff --
Please move the script tag into the included file, and add the `defer` property.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on the pull request:
https://github.com/apache/cordova-docs/pull/581#issuecomment-211563103
LGTM.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60328734
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,27 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+ <script type="text/javascript">
+ docsearch({
+ apiKey: '0a916ab198bd93d031aa70611271e42e',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': [ "version:6.x","language: {{ language }}" ] }
--- End diff --
It is the same language value that is used. I think it is ok with defining it on top...
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by nikhilkh <gi...@git.apache.org>.
Github user nikhilkh commented on the pull request:
https://github.com/apache/cordova-docs/pull/581#issuecomment-211647212
Let's merge this only after indexing is complete
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60674594
--- Diff: www/static/css-src/main.scss ---
@@ -194,6 +194,23 @@ code {
color: #000000;
}
+/* algolia search formatting */
+.algolia-docsearch-suggestion--category-header, .algolia-docsearch-suggestion {
+ font-family: "Raleway", Helvetica, Arial, sans-serif !important;
+}
+
+.algolia-docsearch-suggestion--category-header {
+ background-color: #262626 !important;
+ font-size: 16px !important;
+ font-weight: bold !important;
+ line-height: 30px !important;
+}
+
+.algolia-docsearch-suggestion {
+ font-size: 14px !important;
+ font-weight: 300 !important;
+}
+
--- End diff --
@dblotsky Removed the search form based on the screen width. Please review
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60329698
--- Diff: www/_includes/header.html ---
@@ -29,18 +29,24 @@
<li>
<a href="{{ site.baseurl }}/#getstarted">Get Started</a>
</li>
+ <li>
+ <form class="navbar-form navbar-right" id="header-search-form" role="search">
+ <div class="input-group">
+ {% if page.version %}
--- End diff --
Done
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60329718
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,20 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
--- End diff --
Done
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60313932
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,27 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+ <script type="text/javascript">
+ docsearch({
+ apiKey: '0a916ab198bd93d031aa70611271e42e',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': [ "version:6.x","language: {{ language }}" ] }
--- End diff --
Please use `page.version` for the version here, defaulting to `site.latest_docs_version`. Also, it is more readable to use the full logic from line 6. The duplication is ok, since it decouples the code at the top from this code.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60328800
--- Diff: conf/_config.yml ---
@@ -81,3 +81,5 @@ kramdown:
# exclude these directories from the build
exclude:
- static/css-src
+
+algolia_api_key: "0a916ab198bd93d031aa70611271e42e"
--- End diff --
General comment: should this be kept in the private SVN repo? If so, should we store a dummy value here to be replaced by committers building the site?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60328845
--- Diff: www/_includes/algolia.html ---
@@ -0,0 +1,14 @@
+{% if page.version %}
+ {% assign version = page.version %}
+{% else %}
+ {% assign version = site.latest_docs_version %}
+{% endif %}
+
+<script type="text/javascript">
+ docsearch({
+ apiKey: '{{ site.algolia_api_key }}',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': ["version: {{ version }}", "language: {{ language }}"] }
--- End diff --
The `language` variable is not defined here.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60328530
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,27 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+ <script type="text/javascript">
+ docsearch({
+ apiKey: '0a916ab198bd93d031aa70611271e42e',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': [ "version:6.x","language: {{ language }}" ] }
--- End diff --
Done
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60313371
--- Diff: www/static/css-src/main.scss ---
@@ -194,6 +194,23 @@ code {
color: #000000;
}
+/* algolia search formatting */
+.algolia-docsearch-suggestion--category-header, .algolia-docsearch-suggestion {
+ font-family: "Raleway", Helvetica, Arial, sans-serif;
+}
--- End diff --
Is the font being overridden in the Algolia CSS file? If not, the existing font rules for `body` should cover fonts for this widget.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60329126
--- Diff: www/_includes/header.html ---
@@ -29,18 +29,24 @@
<li>
<a href="{{ site.baseurl }}/#getstarted">Get Started</a>
</li>
+ <li>
+ <form class="navbar-form navbar-right" id="header-search-form" role="search">
+ <div class="input-group">
+ {% if page.version %}
--- End diff --
Nitpick: please indent this block; it looks weird indented one level lower than the code below it.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60328400
--- Diff: www/_includes/head.html ---
@@ -18,6 +18,9 @@
{% endif %}
</title>
+ <!-- Algolia Search CSS -->
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css" />
+
--- End diff --
Done
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on the pull request:
https://github.com/apache/cordova-docs/pull/581#issuecomment-212179026
LGTM.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by rakatyal <gi...@git.apache.org>.
Github user rakatyal commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60329788
--- Diff: conf/_config.yml ---
@@ -81,3 +81,5 @@ kramdown:
# exclude these directories from the build
exclude:
- static/css-src
+
+algolia_api_key: "0a916ab198bd93d031aa70611271e42e"
--- End diff --
:-) :-)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60312014
--- Diff: www/_includes/head.html ---
@@ -18,6 +18,9 @@
{% endif %}
</title>
+ <!-- Algolia Search CSS -->
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css" />
+
--- End diff --
Please put this with the CSS links below.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by dblotsky <gi...@git.apache.org>.
Github user dblotsky commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60334146
--- Diff: www/static/css-src/main.scss ---
@@ -194,6 +194,23 @@ code {
color: #000000;
}
+/* algolia search formatting */
+.algolia-docsearch-suggestion--category-header, .algolia-docsearch-suggestion {
+ font-family: "Raleway", Helvetica, Arial, sans-serif !important;
+}
+
+.algolia-docsearch-suggestion--category-header {
+ background-color: #262626 !important;
+ font-size: 16px !important;
+ font-weight: bold !important;
+ line-height: 30px !important;
+}
+
+.algolia-docsearch-suggestion {
+ font-size: 14px !important;
+ font-weight: 300 !important;
+}
+
--- End diff --
I just tried this guy in my browser, and it looks like there are just a few inconsistencies with the current styling.
Old:
New:
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org
[GitHub] cordova-docs pull request: CB-11104: Integrate Algolia Search to c...
Posted by sarangan12 <gi...@git.apache.org>.
Github user sarangan12 commented on a diff in the pull request:
https://github.com/apache/cordova-docs/pull/581#discussion_r60328435
--- Diff: www/_layouts/base.html ---
@@ -3,12 +3,27 @@
---
<!DOCTYPE html>
-<html lang="{% if page.language %}{{ page.language }}{% else %}{{ site.language }}{% endif %}">
+{% if page.language %}
+ {% assign language = page.language %}
+{% else %}
+ {% assign language = site.language %}
+{% endif %}
+
+<html lang="{{ language }}">
{% include head.html %}
<body>
{{ content }}
{% include analytics.html %}
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/index.js"></script>
<script defer type="text/javascript" src="{{ site.baseurl }}/static/js/twitter.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script>
+ <script type="text/javascript">
+ docsearch({
+ apiKey: '0a916ab198bd93d031aa70611271e42e',
+ indexName: 'cordova',
+ inputSelector: '#header-search-field',
+ algoliaOptions: { 'facetFilters': [ "version:6.x","language: {{ language }}" ] }
+ });
+ </script>
--- End diff --
Fixed the indentation and moved it to algolia.html
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org