This is the source to Jupyter.org.
The site is built with Jekyll, see the Jekyll website for how to customize the build process.
There are a few ways to build the site locally, see the sections below.
The easiest way to build the site locally is by using the nox
command line tool. This tool makes it easy to automate commands in a repository, and we have included a build
command to quickly install the dependencies and build the site.
To build and preview the site locally, follow these steps:
-
Clone this repository.
$ git clone https://github.com/jupyter/jupyter.github.io $ cd jupyter.github.io
-
Install
nox
$ pip install nox
-
Run the
build
command$ nox -s build-live
This will install the needed dependencies in a virtual environment using the conda
package manager.
When the build is finished, go to localhost:4000
. When Jekyll finishes building your site, it will open a port on your computer and serve the website there so that you may preview it.
You can make changes and watch the preview auto-update. When you make changes to the website, they will automatically be updated in your preview in the browser.
To stop serving the website, press Ctrl
-C
in your terminal
To build the site manually, you'll need Ruby, Jekyll, and the packages that Jekyll uses to build the site (these are defined in Gemfile
).
Follow these steps:
-
Install Jekyll. You have two options:
-
Follow the Jekyll installation instructions. These steps will guide you through installing Ruby and Jekyll locally.
-
Use the anaconda distribution and conda-forge.
First install miniconda, then run the following command:
$ conda install -c conda-forge ruby c-compiler compilers cxx-compiler
Finally install Jekyll and Bundler, which will let you install the site's dependencies:
$ gem install jekyll bundler
-
-
Install the site's build dependencies. These are specified in
Gemfile
.$ bundle install
This step might take a few moments as it must download and install a number of local extensions. It will create a local file called
Gemfile.lock
. These are the "frozen" dependencies and their version numbers needed to build the site. -
Build the site locally.
$ bundle exec jekyll serve liveserve
This will build the site's HTML and open a server at
localhost:4000
for you to preview the site.
The site is automatically built with Netlify, a hosting service for static websites. When any changes are merged into the master
branch, Netlify will automatically build them and update the website at jupyter.org.
Netlify will automatically build a preview of the website in an open Pull Request. To see this, click on the Show all checks
button just above the comment box in the Pull Request window. Then click on the details
link on the deploy/netlify
row to see a preview of the built site.
Here's an image of this box on a GitHub PR page:
Most pages are located at the place where their URL is, nothing fancy. Some are written in HTML. Others are written in Markdown. The homepage is in index.html. The about page is in
about.md`.
Create my_page.html
(will have url https://jupyter.org/my_page.html
)
or my_page/index.html
(will have url https://jupyter.org/my_page/
), start with the following:
---
layout: default
title: My Page
---
write some html here (consider you are already inside `<body></body>`)
You cannot do it yet with .md file, but you will be able soon.
Add commit (and don't forget to add to _data/nav.yml
).
Shortcuts with colors and other common variables can be found in _sass/settings
. They can be used in SCSS files.
@import "settings/colors"
a {
color: $orange;
}
The Jupyter website uses lazy loading of images. In general, images that are "below the fold" (below the browser window on page load) for laptop-sized screen sizes are encouraged to be configured for "lazy loading".
Add lazy loading to an image by adding a loading="lazy"
configuration to the <img>
element. For example:
<img class="my-class" src="my/src.png" loading="lazy" />
For images that are "above the fold" (that will be seen by users immediately after page load), use "eager" loading to make sure they are loaded immediately. For example:
<img class="my-class" src="my/src.png" loading="eager" />
A workflow on GitHub Actions is run at every push and for every pull request to ensure basic integrity of the website:
- validating the structure of the HTML using Nu validator to ensure compliance with HTML standards
- checking linked URLs for errors (including expired certificates)
- running Lighthouse audits to ensure performance, accessibility, SEO optimization and best practices
If pre-defined quality targets are not met, the jobs will fail. Click on "Details" link for the failing job to see what caused the failure.
The detailed results will be available in the logs (which are only shown to users logged in on GitHub), including links to full Lighthouse reports on public temporary storage (the links will expire after 7 days).