Skip to content

Commit

Permalink
Added jupyter to README (alshedivat#1637)
Browse files Browse the repository at this point in the history
Signed-off-by: George Araujo <george.gcac@gmail.com>
  • Loading branch information
george-gca authored and wangmagg committed May 14, 2024
1 parent 0aa0ee9 commit 1964fd1
Showing 1 changed file with 21 additions and 17 deletions.
38 changes: 21 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,31 +154,33 @@ Medical Robotics Junior Faculty Forum (ISMR: <a href="https://junior-forum-ismr.

## Table Of Contents

* [User community](#user-community)
* [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
* [Getting started](#getting-started)
+ [Installation](#installation)
- [al-folio](#al-folio)
- [User community](#user-community)
- [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
- [Table Of Contents](#table-of-contents)
- [Getting started](#getting-started)
- [Installation](#installation)
- [Local setup using Docker (Recommended on Windows)](#local-setup-using-docker-recommended-on-windows)
- [Local Setup (Standard)](#local-setup-standard)
- [Deployment](#deployment)
- [Upgrading from a previous version](#upgrading-from-a-previous-version)
+ [FAQ](#faq)
* [Features](#features)
+ [Publications](#publications)
+ [Collections](#collections)
+ [Layouts](#layouts)
- [FAQ](#faq)
- [Features](#features)
- [Publications](#publications)
- [Collections](#collections)
- [Layouts](#layouts)
- [The iconic style of Distill](#the-iconic-style-of-distill)
- [Full support for math & code](#full-support-for-math--code)
- [Full support for math \& code](#full-support-for-math--code)
- [Photos](#photos)
+ [Other features](#other-features)
- [GitHub repositories and user stats](#github-repositories-and-user-stats)
- [Other features](#other-features)
- [GitHub's repositories and user stats](#githubs-repositories-and-user-stats)
- [Theming](#theming)
- [Social media previews](#social-media-previews)
- [Atom (RSS-like) Feed](#atom-rss-like-feed)
- [Related posts](#related-posts)
* [Contributing](#contributing)
+ [Core Contributors](#core-contributors)
* [License](#license)
- [Contributing](#contributing)
- [Maintainers](#maintainers)
- [License](#license)

## Getting started

Expand Down Expand Up @@ -236,10 +238,12 @@ $ docker-compose -f docker-local.yml up

#### Local Setup (Standard)

Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*).
Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (*hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)*), and also [Python](https://www.python.org/) and [pip](https://pypi.org/project/pip/) (*hint: for ease of managing python packages, consider using a virtual environment, like [venv](https://docs.python.org/pt-br/3/library/venv.html) or [conda](https://docs.conda.io/en/latest/). If you will use only `jupyter`, you can use [pipx](https://pypa.github.io/pipx/)*).

```bash
$ bundle install
# assuming pip is your Python package manager
$ pip install jupyter
$ bundle exec jekyll serve --lsi
```

Expand Down Expand Up @@ -419,7 +423,7 @@ If you have a different question, please ask using [Discussions](https://github.
If you are deploying a project page, set `baseurl: /<your-project-name>/`.
If all previous steps were done correctly, all is missing is
[for your browser to fetch again the site stylesheet](https://github.com/alshedivat/al-folio/issues/1398#issuecomment-1609518404).

5. **Q:** Atom feed doesn't work. Why?
<br>
**A:** Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`.
Expand Down

0 comments on commit 1964fd1

Please sign in to comment.