Jupyter.github.io

Theme by Jupyter

|

Updated: 16 May 2025

|

190 Stars

Project Jupyter's home on the World Wide Web

Overview

Jupyter.org is the main website for Jupyter, an open-source project that provides a web-based interactive computing platform. The website serves as a hub for information, documentation, and resources related to Jupyter. It is built using Jekyll, a static site generator, and is hosted on GitHub Pages. The site can be built and previewed locally using different methods.

Features

• Build the site locally using Jekyll and customize the build process.
• Preview changes in a Pull Request using Netlify.
• Build the site automatically with the nox command line tool.
• Build the site manually using Ruby, Jekyll, and Bundler.

Installation

To build and preview the site locally using the nox command line tool, follow these steps:

1. Clone the repository.
2. Install nox.
3. Run the build command.

git clone [repository_url]
pip install nox
nox build

To build the site manually, follow these steps:

1. Install Jekyll using one of the following options:

   • Follow the Jekyll installation instructions to install Ruby and Jekyll locally.
   • Use the anaconda distribution and conda-forge. Install miniconda, then run the following command:

   conda install -c conda-forge ruby jekyll bundler
   

2. Install the site’s build dependencies specified in the Gemfile.

bundle install

3. Build the site locally.

jekyll build

Summary

Jupyter.org is the main website for the Jupyter project, providing information and resources related to Jupyter. It is built using Jekyll and can be previewed locally using the nox command line tool or built manually using Ruby and Jekyll. The site also utilizes Netlify for previewing changes in Pull Requests.