You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+46-11
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,10 @@ This is the source to [Jupyter.org](https://jupyter.org/).
6
6
7
7
The site is built with Jekyll, see [the Jekyll website](https://jekyllrb.com/) for how to customize the build process.
8
8
9
+
There are a few ways to build the site locally, see the sections below.
10
+
11
+
### Build the site automatically with `nox`
12
+
9
13
The easiest way to build the site locally is by using the [`nox` command line tool](https://nox.thea.codes/). 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.
10
14
11
15
To build and preview the site locally, follow these steps:
@@ -38,13 +42,53 @@ To stop serving the website, press **`Ctrl`**-`C` in your terminal
38
42
39
43
### Build the site manually
40
44
41
-
To build the site manually, check out the installation commands that are in `noxfile.py`. These use `nox` syntax, but they should give you a clear idea of which packages must be installed in order to build the documentation.
45
+
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`](Gemfile)).
46
+
47
+
Follow these steps:
48
+
49
+
1.**Install Jekyll**. You have two options:
50
+
-[Follow the Jekyll installation instructions](https://jekyllrb.com/docs/#instructions). These steps will guide you through installing Ruby and Jekyll locally.
51
+
- Use [the anaconda distribution](https://conda.io) and [conda-forge](https://conda-forge.org/).
52
+
53
+
First [install miniconda](https://conda.io/miniconda.html), then run the following command:
Finally install Jekyll and Bundler, which will let you install the site's dependencies:
60
+
61
+
```console
62
+
$ gem install jekyll bundler
63
+
```
64
+
2. **Install the site's build dependencies**. These are specified in [`Gemfile`](Gemfile).
65
+
66
+
```console
67
+
$ bundle install
68
+
```
69
+
70
+
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.
71
+
72
+
3.**Build the site locally**.
73
+
74
+
```console
75
+
$ bundle exec jekyll serve liveserve
76
+
```
77
+
78
+
This will build the site's HTML and open a server at `localhost:4000` for you to preview the site.
79
+
42
80
43
81
## Where the site is hosted
44
82
45
83
The site is automatically built with [Netlify](https://netlify.com), 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](https://jupyter.org).
46
84
47
-
**You can preview changes in Pull Requests**. 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 **`deploy/netlify`** to see a preview of the built site.
85
+
## Preview changes in a Pull Request
86
+
87
+
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.
0 commit comments