Skip to content

[ZEPPELIN-990] Add header anchor for Zeppelin documentation site #995

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 9 commits into from
Closed

[ZEPPELIN-990] Add header anchor for Zeppelin documentation site #995

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
94b38cd
Add anchor.min.js
AhyoungRyu Jun 10, 2016
475d0d8
Enable anchor.min.js in Zeppelin docs site
AhyoungRyu Jun 10, 2016
21be556
Disable decoration below the anchor
AhyoungRyu Jun 10, 2016
05e0f36
Change anchor placement right->left
AhyoungRyu Jun 12, 2016
0d218a2
Add anchor.js license
AhyoungRyu Jun 12, 2016
ff614a2
Add anchor.min.js to rat plugin exclude list
AhyoungRyu Jun 12, 2016
8fa7fd6
Remove useless white space in docs.js
AhyoungRyu Jun 13, 2016
06a2edd
Change license location
AhyoungRyu Jun 13, 2016
14625c8
Revert LICENSE file
AhyoungRyu Jun 13, 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
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ The text of each license is also included at licenses/LICENSE-[project]-[version
(The MIT License) Simple line icons v1.0.0 (http://thesabbir.github.io/simple-line-icons/) - https://github.com/thesabbir/simple-line-icons/tree/1.0.0
(The MIT License) jekyll-bootstrap 0.3.0 (https://github.com/plusjade/jekyll-bootstrap) - https://github.com/plusjade/jekyll-bootstrap
(The MIT License) jekyll 1.3.0 (http://jekyllrb.com/) - https://github.com/jekyll/jekyll/blob/v1.3.0/LICENSE

(MIT License) AnchorJS (https://github.com/bryanbraun/anchorjs)


========================================================================
Expand Down
1 change: 1 addition & 0 deletions docs/_includes/themes/zeppelin/default.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
<script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="{{ ASSET_PATH }}/bootstrap/js/bootstrap.min.js"></script>
<script src="{{ ASSET_PATH }}/js/docs.js"></script>
<script src="{{ ASSET_PATH }}/js/anchor.min.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
2 changes: 2 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 @@ -523,6 +523,8 @@ a.anchor {
background: #286090;
}

a.anchorjs-link:hover { text-decoration: none; }

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

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

9 changes: 7 additions & 2 deletions docs/assets/themes/zeppelin/js/docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,18 @@ function maybeScrollToHash() {

$(function() {
codeTabs();
viewSolution();
// Display anchor links when hovering over headers. For documentation of the
// configuration options, see the AnchorJS documentation.
anchors.options = {
placement: 'left'
};
anchors.add();

$(window).bind('hashchange', function() {
maybeScrollToHash();
});

// Scroll now too in case we had opened the page on a hash, but wait a bit because some browsers
// will try to do *their* initial scroll after running the onReady handler.
$(window).load(function() { setTimeout(function() { maybeScrollToHash(); }, 25); });
$(window).load(function() { setTimeout(function() { maybeScrollToHash(); }, 25); });

@corneadoug corneadoug Jun 13, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:O

@AhyoungRyu AhyoungRyu Jun 13, 2016

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@corneadoug I removed it :octocat:

});
3 changes: 3 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,9 @@
<exclude>docs/sitemap.txt</exclude>
<exclude>**/dependency-reduced-pom.xml</exclude>

<!-- bundled from anchor -->
<exclude>docs/assets/themes/zeppelin/js/anchor.min.js</exclude>

<!-- bundled from jekyll -->
<exclude>docs/assets/themes/zeppelin/css/syntax.css</exclude>

Expand Down