Skip to content

[ZEPPELIN-1219] Add searching feature to Zeppelin docs site #1266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AhyoungRyu wants to merge 21 commits into from
Closed

[ZEPPELIN-1219] Add searching feature to Zeppelin docs site #1266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
0705bd6
Add js files: lunr.min.js & search.js
AhyoungRyu Aug 2, 2016
040f532
Add template for storing docs info based on jekyll front matter
AhyoungRyu Aug 2, 2016
0688a79
Keep consistency all docs' front matter for the right search result
AhyoungRyu Aug 2, 2016
a951fa6
Add search icon to navbar
AhyoungRyu Aug 2, 2016
d908c37
Add searching page
AhyoungRyu Aug 2, 2016
68eb997
Attach 'Apache Zeppelin ZEPPELIN_VERSION Documentation: ' to title
AhyoungRyu Aug 2, 2016
f6a05a6
Apply css style for the search results
AhyoungRyu Aug 2, 2016
36ba7f1
Add lunr.min.js license info
AhyoungRyu Aug 2, 2016
da0cff9
Exclude lunr.min.js
AhyoungRyu Aug 2, 2016
fa01299
Refine 'description' in some docs as @bzz suggested
AhyoungRyu Aug 3, 2016
ee11136
Fix some typos
AhyoungRyu Aug 3, 2016
6e775f5
Make pleasecontribute.md not to be searched
AhyoungRyu Aug 3, 2016
1381152
Fix search result skipping issue
AhyoungRyu Aug 3, 2016
624b051
Add Apache license header to search.js
AhyoungRyu Aug 3, 2016
bd4956a
Add docs.js & search.js to exclude list in pom.xml
AhyoungRyu Aug 3, 2016
9f1ba42
Disable enterkey press & change icon
AhyoungRyu Aug 3, 2016
0389d28
Make index.md not to be searched
AhyoungRyu Aug 3, 2016
6784282
Minor search page UI update
AhyoungRyu Aug 3, 2016
34afd5d
Add Apache license header to search_data.json
AhyoungRyu Aug 4, 2016
91b71a7
Remove Apache license header since JSON doesn't allow comment
AhyoungRyu Aug 6, 2016
7ec8854
Modify 'no result' sentence
AhyoungRyu Aug 6, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,8 @@ The following components are provided under the MIT-style license. See project l
The text of each license is also included at licenses/LICENSE-[project]-[version].txt.

(MIT Style) jekyll-table-of-contents (https://github.com/ghiculescu/jekyll-table-of-contents) - https://github.com/ghiculescu/jekyll-table-of-contents/blob/master/LICENSE.txt

(MIT Style) lunr.js (https://github.com/olivernn/lunr.js) - https://github.com/olivernn/lunr.js/blob/v0.7.1/LICENSE

========================================================================
Apache licenses
========================================================================
Expand Down
9 changes: 8 additions & 1 deletion docs/_includes/themes/zeppelin/_navigation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,14 @@
</ul>
</li>
</ul>
<ul class="nav navbar-nav">
<li>
<a href="{{BASE_PATH}}/search.html" class="nav-search-link">
<span class="fa fa-search nav-search-icon"></span>
</a>
</li>
</ul>
</nav><!--/.navbar-collapse -->
</div>
</div>

4 changes: 3 additions & 1 deletion docs/_includes/themes/zeppelin/default.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<title>{{ page.title }}</title>
<title>Apache Zeppelin {{ site.ZEPPELIN_VERSION }} Documentation: {{ page.title }}</title>
{% if page.description %}<meta name="description" content="{{ page.description }}">{% endif %}
<meta name="author" content="{{ site.author.name }}">

Expand Down Expand Up @@ -34,6 +34,8 @@
<script src="{{ ASSET_PATH }}/js/docs.js"></script>
<script src="{{ ASSET_PATH }}/js/anchor.min.js"></script>
<script src="{{ ASSET_PATH }}/js/toc.js"></script>
<script src="{{ ASSET_PATH }}/js/lunr.min.js"></script>
<script src="{{ ASSET_PATH }}/js/search.js"></script>

<!-- atom & rss feed -->
<link href="{{ BASE_PATH }}{{ site.JB.atom_path }}" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
Expand Down
24 changes: 24 additions & 0 deletions docs/assets/themes/zeppelin/css/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,30 @@ a.anchorjs-link:hover { text-decoration: none; }
margin-left: -18px;
}

/* Search Page */
#search p {
font-size: 30px;
font-weight: bold;
color: black;
}

#search_results p {
font-size: 13px;
font-weight: 400;
}

#search_results a {
vertical-align: super;
font-size: 16px;
text-decoration: underline;
}

#search_results .link {
font-size: 13px;
color: #008000;
padding-bottom: 3px;
}

/* Custom, iPhone Retina */
@media only screen and (max-width: 480px) {
.jumbotron h1 {
Expand Down
7 changes: 7 additions & 0 deletions docs/assets/themes/zeppelin/js/lunr.min.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading