Skip to content

Commit 551b647

Browse files
CarreauCarreau
committed
Build jupyter.org website with jekyll
1 parent 27fe983 commit 551b647

20 files changed

+875
-396
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_site

‎Gemfile

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source 'https://rubygems.org'
2+
gem 'github-pages'

‎README.md

+78
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,81 @@
11
# Jupyter's main website
22

33
This is the source to [Jupyter.org](http://jupyter.org/).
4+
5+
# Build instruction.
6+
7+
The site is build using GitHub Pages Jekyll, see [Jekyll
8+
website](http://jekyllrb.com/) for customizing build process, and detail on how
9+
what where.
10+
11+
# Quick local testing
12+
13+
```
14+
$ gem install jekyll
15+
```
16+
17+
cd into the root of this directory,
18+
19+
```
20+
jekyll serve --base-url ''
21+
```
22+
23+
Open your browser to localhost:4000
24+
25+
Edit the various part and reload at will.
26+
27+
Enjoy
28+
29+
# What is where.
30+
31+
Most pages are located at the place where their URL is, nothing fancy. Headers
32+
and footer are in `_includes/head.html`, `_includes/header.html` ,
33+
`_includes/footer.html`.
34+
35+
The **navbar** is in `_data/nav.yml` and look like that:
36+
37+
```
38+
head:
39+
- Home
40+
- title: Install
41+
url: http://jupyter.readthedocs.org/en/latest/install.html
42+
- About
43+
- title: Documentation
44+
url: http://jupyter.readthedocs.org/en/latest/install.html
45+
- title: Blog
46+
url: https://blog.jupyter.org
47+
- Donate
48+
```
49+
50+
which mean, insert in order the following links into the navbar:
51+
52+
- Link to `Home` page, guess the url by yourself.
53+
- link to `Install` page, the url is...
54+
- Link to `About`, guess the url by yourself,
55+
- ... etc.
56+
57+
The navbar will automatically target `_blank` pages where the url is explicit,
58+
and mark the correct link as the "current" one.
59+
60+
# How do I create a new page ?
61+
62+
Create `my_page.html` (will have url `https://jupyter.org/my_page.html`)
63+
or `my_page/index.html` (will have url `https://jupyter.org/my_page/`), start with the following :
64+
65+
```
66+
---
67+
layout: default
68+
title: My Page
69+
navbar_gray: true
70+
---
71+
72+
write some html here (consider you are already inside `<body></body>`
73+
```
74+
75+
You can not do it yet with .md file, but you will be able soon.
76+
77+
Add commit (and don't forget to add to `_data/nav.yml`
78+
79+
`navbar_gray: true` start the navbar with a grey background if you need it.
80+
81+

‎_config.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Site settings
2+
title: Project Jupyter
3+
email: [email protected]
4+
description: > # this means to ignore newlines until "baseurl:"
5+
The Jupyter Notebook is a web-based interactive computing platform. The
6+
notebook combines live code, equations, narrative text, visualizations,
7+
interactive dashboards and other media.
8+
baseurl: "/jupyter.github.io" # the subpath of your site, e.g. /blog/
9+
url: "http://jupyter.org" # the base hostname & protocol for your site
10+
twitter_username: ProjectJupyter
11+
github_username: Jupyter
12+
13+
# Build settings
14+
markdown: kramdown

‎_data/nav.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
head:
2+
- title: Install
3+
url: http://jupyter.readthedocs.org/en/latest/install.html
4+
- Project
5+
- title: Documentation
6+
url: http://jupyter.readthedocs.org/en/latest/install.html
7+
- title: Blog
8+
url: https://blog.jupyter.org
9+
- Donate

‎_includes/footer.html

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<footer>
2+
<div class="navbar-bottom" role="navigation" id="footer1">
3+
<div class="container">
4+
<div class="navbar-text">
5+
<ul id="footer-text">
6+
<li><a href="{{site.baseurl}}">Home</a></li>
7+
{% for nav in site.data.nav.head %}
8+
{% if nav.url %}
9+
<li><a href="{{site.baseurl}}{{nav.url}}" target="_blank">{{nav.title}}</a></li>
10+
{% else %}
11+
{% for ppage in site.pages %}
12+
{% if nav contains ppage.title %}
13+
<li><a href="{{site.baseurl}}{{page.url}}">{{ppage.title}}</a></li>
14+
{% endif %}
15+
{% endfor %}
16+
{% endif %}
17+
{% endfor %}
18+
<p>Copyright © {{site.time | date: '%Y' }} Project Jupyter - Last updated {{site.time | date: "%a, %b %d, %Y" }}</p>
19+
</ul>
20+
</div>
21+
<div class="follow">
22+
<a class="github-button" href="https://github.com/jupyter" aria-label="Follow @jupyter on GitHub">Follow @jupyter</a>
23+
<br><a href="https://twitter.com/ProjectJupyter" class="twitter-follow-button" data-show-count="false">Follow @ProjectJupyter</a>
24+
</div>
25+
</div>
26+
</div>
27+
</footer>
28+
29+
<!-- jQuery -->
30+
<script src="{{site.baseurl}}/js/jquery.js"></script>
31+
32+
<!-- Bootstrap Core JavaScript -->
33+
<script src="{{site.baseurl}}/js/bootstrap.min.js"></script>
34+
<!-- Place this tag right after the last button or just before your close body tag. -->
35+
<script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
36+
<script src="{{site.baseurl}}/js/scroll.js"></script>
37+
<script src="{{site.baseurl}}/js/architecture.js"></script>
38+
<script src="{{site.baseurl}}/js/simon.js"></script>
39+
<script src="{{site.baseurl}}/js/timeline/main.js"></script> <!-- Resource jQuery -->
40+
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>

‎_includes/head.html

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<head>
2+
3+
<meta charset="utf-8">
4+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
5+
<meta name="viewport" content="width=device-width, initial-scale=1">
6+
<meta name="description" content="">
7+
<meta name="author" content="">
8+
9+
<title>{{ site.title }} {% if page.title %}| {{ page.title }}{% endif %}</title>
10+
<meta property="og:title" content="Project Jupyter" />
11+
<meta property="og:description" content="{{ site.description }}" />
12+
<meta name="description" content="{{ site.description }}">
13+
<meta property="og:url" content="http://www.jupyter.org" />
14+
<meta property="og:image" content="http://jupyter.org/assets/homepage.png" />
15+
<!-- Bootstrap Core CSS -->
16+
<link rel="stylesheet" href="{{ "/css/bootstrap.min.css" | prepend: site.baseurl }}">
17+
<link rel="stylesheet" href="{{ "/css/logo-nav.css" | prepend: site.baseurl }}">
18+
<link rel="icon" type="image/png" href="favicon.ico" />
19+
<link href="{{site.baseurl}}/assets/apple-touch-icon.png" rel="apple-touch-icon" />
20+
<link href="{{site.baseurl}}/assets/apple-touch-icon-76x76.png" rel="apple-touch-icon" sizes="76x76" />
21+
<link href="{{site.baseurl}}/assets/apple-touch-icon-120x120.png" rel="apple-touch-icon" sizes="120x120" />
22+
<link href="{{site.baseurl}}/assets/apple-touch-icon-152x152.png" rel="apple-touch-icon" sizes="152x152" />
23+
<link href="{{site.baseurl}}/assets/apple-touch-icon-180x180.png" rel="apple-touch-icon" sizes="180x180" />
24+
<link href="{{site.baseurl}}/assets/icon-hires.png" rel="icon" sizes="192x192" />
25+
<link href="{{site.baseurl}}/assets/icon-normal.png" rel="icon" sizes="128x128" />
26+
<link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
27+
28+
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
29+
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
30+
<!--[if lt IE 9]>
31+
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
32+
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
33+
<![endif]-->
34+
<script src="//use.typekit.net/kpd5yrh.js"></script>
35+
<script>try{Typekit.load();}catch(e){}</script>
36+
<script>
37+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
38+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
39+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
40+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
41+
42+
ga('create', 'UA-52617120-1', 'auto');
43+
ga('send', 'pageview');
44+
45+
</script>
46+
</head>
47+

‎_includes/header.html

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<nav class="navbar navbar-fixed-top {% if page.navbar_gray %}navbar-gray{%endif%}" role="navigation" id="navbar" >
2+
<div class="navbar-inner">
3+
<div class="container">
4+
<!-- Brand and toggle get grouped for better mobile display -->
5+
<div class="navbar-header">
6+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
7+
<span class="sr-only">Toggle navigation</span>
8+
<span class="icon-bar"></span>
9+
<span class="icon-bar"></span>
10+
<span class="icon-bar"></span>
11+
</button>
12+
<a class="navbar-brand" href="{{site.baseurl}}/index.html">
13+
<img src="{{site.baseurl}}/assets/nav_logo.svg" style="height:45px;">
14+
</a>
15+
</div>
16+
<!-- Collect the nav links, forms, and other content for toggling -->
17+
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
18+
<ul class="nav navbar-nav navbar-right">
19+
{% for nav in site.data.nav.head %}
20+
{% if nav.url %}
21+
<li>
22+
<a href="{{site.baseurl}}{{nav.url}}" class="tab" id="tab" target="_blank">{{nav.title | upcase}}</a>
23+
</li>
24+
{% else %}
25+
{% for targetpage in site.pages %}
26+
{% if nav contains targetpage.title%}
27+
{% if page.title == targetpage.title %}
28+
<li>
29+
<a href class="tab navbar-active" id="tab">{{targetpage.title| upcase}}</a>
30+
</li>
31+
{% else %}
32+
<li>
33+
<a href="{{site.baseurl}}{{targetpage.url}}" class="tab" id="tab">{{targetpage.title| upcase}}</a>
34+
</li>
35+
{% endif %}
36+
{% endif %}
37+
{% endfor %}
38+
{% endif %}
39+
{% endfor %}
40+
<!--<li>
41+
<a href="http://jupyter.readthedocs.org/en/latest/install.html" class="tab" id="tab" target="_blank">INSTALL</a>
42+
</li>
43+
<li>
44+
<a href="{{site.baseurl}}/about.html" class="tab">PROJECT</a>
45+
</li>
46+
<li>
47+
<a href="http://jupyter.readthedocs.org/en/latest/" class="tab" target="_blank">DOCUMENTATION</a>
48+
</li>
49+
<li>
50+
<a href="https://blog.jupyter.org/" class="tab" target="_blank">BLOG</a>
51+
</li>
52+
<li>
53+
<a href="{{site.baseurl}}/donate.html" class="tab">DONATE</a>
54+
</li>
55+
-->
56+
<!-- <li>
57+
<a href="#" class="tab" id="tab">DONATE</a>
58+
</li> -->
59+
</ul>
60+
</div>
61+
<!-- /.navbar-collapse -->
62+
</div>
63+
<!-- /.container -->
64+
</div>
65+
</nav>

‎_layouts/default.html

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!DOCTYPE html>
2+
<html>
3+
4+
{% include head.html %}
5+
6+
<body>
7+
8+
{% include header.html %}
9+
<section>
10+
{{ content }}
11+
</section>
12+
13+
{% include footer.html %}
14+
15+
</body>
16+
17+
</html>

‎_layouts/page.html

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
layout: default
3+
---
4+
<div class="post">
5+
6+
<header class="post-header">
7+
<h1 class="post-title">{{ page.title }}</h1>
8+
</header>
9+
10+
<article class="post-content">
11+
{{ content }}
12+
</article>
13+
14+
</div>

‎_layouts/post.html

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
layout: default
3+
---
4+
<div class="post">
5+
6+
<header class="post-header">
7+
<h1 class="post-title">{{ page.title }}</h1>
8+
<p class="post-meta">{{ page.date | date: "%b %-d, %Y" }}{% if page.author %} • {{ page.author }}{% endif %}{% if page.meta %} • {{ page.meta }}{% endif %}</p>
9+
</header>
10+
11+
<article class="post-content">
12+
{{ content }}
13+
</article>
14+
15+
</div>

0 commit comments

Comments
 (0)