Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Project Jupyter's home on the World Wide Web

License

NotificationsYou must be signed in to change notification settings

jupyter/jupyter.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

This is the source toJupyter.org.

Where the site is hosted

There are two ways that this site is built:

  • Pull Request previews are built withNetlify, a hosting service for static websites. See the section below for more information.
  • Hosting for jupyter.org is done viaGitHub Pages. GitHub will automatically use Jekyll to build the HTML for this site and host it atjupyter.github.io, which connects withjupyter.org.

Preview changes in a Pull Request

Netlify will automatically build a preview of the website in an open Pull Request. To see this, click on theShow all checks button just above the comment box in the Pull Request window. Then click on thedetails link on thedeploy/netlify row to see a preview of the built site.

Here's an image of this box on a GitHub PR page:

Netlify Preview Button

Web analytics (experimental)

We are experimenting withPlausible.io for web analytics.Access it at this link, using the1Password for login credentials.

Plausible dashboard link:https://plausible.io/jupyter.org/

Build the site locally

See the sections below for a few ways to build the site locally.

The site is built with Jekyll, seethe Jekyll website for how to customize the build process.

Build the site automatically withnox

The easiest way to build the site locally is by using thenox command line tool. This tool makes it easy to automate commands in a repository, and we have included abuild command to quickly install the dependencies and build the site.

To build and preview the site locally, follow these steps:

  1. Clone this repository.

    $git clone https://github.com/jupyter/jupyter.github.io$cd jupyter.github.io

  2. Installnox

    $pip install nox

  3. Run thebuild command

    $nox -s build-live

This will install the needed dependencies in a virtual environment usingtheconda package manager.

When the build is finished, go tolocalhost: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, pressCtrl-C in your terminal

Build the site manually

To build the site manually, you'll need Ruby, Jekyll, and the packages that Jekyll uses to build the site (these are defined inGemfile).

Follow these steps:

  1. Install Jekyll. You have two options:

  2. Install the site's build dependencies. These are specified inGemfile.

    $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 calledGemfile.lock. These are the "frozen" dependencies and their version numbers needed to build the site.

  3. Build the site locally.

    $bundleexec jekyll serve liveserve

    This will build the site's HTML and open a server atlocalhost:4000 for you to preview the site.

Structure of this website

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 inindex.html. The about page is inabout.md`.

Create a new page

Createmy_page.html (will have urlhttps://jupyter.org/my_page.html)ormy_page/index.html (will have urlhttps://jupyter.org/my_page/), start with the following:

---layout: defaulttitle: 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).

Site quirks and tips

SCSS variables

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;}

Minifying images

We recommend minifying images whenever adding them to this website. This helps keep the page load times of our website down. There are many minifying services out there, butthesquoosh.app service is a lightweight and easy-to-use option.

Lazy loading of images

The Jupyter website useslazy 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 aloading="lazy" configuration to the<img> element. For example:

<imgclass="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:

<imgclass="my-class"src="my/src.png"loading="eager"/>

Automated quality checks

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 usingNu validator to ensure compliance with HTML standards
  • checking linked URLs for errors (including expired certificates)
  • runningLighthouse 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).

[8]ページ先頭
©2009-2025 Movatter.jp