Added jupyter to README (#1637)
Signed-off-by: George Araujo <george.gcac@gmail.com>
This commit is contained in:
parent
312cbdb4c5
commit
1206429677
38
README.md
38
README.md
|
|
@ -154,31 +154,33 @@ Medical Robotics Junior Faculty Forum (ISMR: <a href="https://junior-forum-ismr.
|
||||||
|
|
||||||
## Table Of Contents
|
## Table Of Contents
|
||||||
|
|
||||||
* [User community](#user-community)
|
- [al-folio](#al-folio)
|
||||||
* [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
|
- [User community](#user-community)
|
||||||
* [Getting started](#getting-started)
|
- [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
|
||||||
+ [Installation](#installation)
|
- [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 using Docker (Recommended on Windows)](#local-setup-using-docker-recommended-on-windows)
|
||||||
- [Local Setup (Standard)](#local-setup-standard)
|
- [Local Setup (Standard)](#local-setup-standard)
|
||||||
- [Deployment](#deployment)
|
- [Deployment](#deployment)
|
||||||
- [Upgrading from a previous version](#upgrading-from-a-previous-version)
|
- [Upgrading from a previous version](#upgrading-from-a-previous-version)
|
||||||
+ [FAQ](#faq)
|
- [FAQ](#faq)
|
||||||
* [Features](#features)
|
- [Features](#features)
|
||||||
+ [Publications](#publications)
|
- [Publications](#publications)
|
||||||
+ [Collections](#collections)
|
- [Collections](#collections)
|
||||||
+ [Layouts](#layouts)
|
- [Layouts](#layouts)
|
||||||
- [The iconic style of Distill](#the-iconic-style-of-distill)
|
- [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)
|
- [Photos](#photos)
|
||||||
+ [Other features](#other-features)
|
- [Other features](#other-features)
|
||||||
- [GitHub repositories and user stats](#github-repositories-and-user-stats)
|
- [GitHub's repositories and user stats](#githubs-repositories-and-user-stats)
|
||||||
- [Theming](#theming)
|
- [Theming](#theming)
|
||||||
- [Social media previews](#social-media-previews)
|
- [Social media previews](#social-media-previews)
|
||||||
- [Atom (RSS-like) Feed](#atom-rss-like-feed)
|
- [Atom (RSS-like) Feed](#atom-rss-like-feed)
|
||||||
- [Related posts](#related-posts)
|
- [Related posts](#related-posts)
|
||||||
* [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
+ [Core Contributors](#core-contributors)
|
- [Maintainers](#maintainers)
|
||||||
* [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
|
|
@ -236,10 +238,12 @@ $ docker-compose -f docker-local.yml up
|
||||||
|
|
||||||
#### Local Setup (Standard)
|
#### 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
|
```bash
|
||||||
$ bundle install
|
$ bundle install
|
||||||
|
# assuming pip is your Python package manager
|
||||||
|
$ pip install jupyter
|
||||||
$ bundle exec jekyll serve --lsi
|
$ bundle exec jekyll serve --lsi
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -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 you are deploying a project page, set `baseurl: /<your-project-name>/`.
|
||||||
If all previous steps were done correctly, all is missing is
|
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).
|
[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?
|
5. **Q:** Atom feed doesn't work. Why?
|
||||||
<br>
|
<br>
|
||||||
**A:** Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`.
|
**A:** Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue