silva
/
new_site
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README to make Docker Recommended way (#1523) 

Docker is well-tested for a long time. I think it is better to make it
the recommended method for all OS types.

This way, it is a lot easier to install docker (than to install jekyll
and ruby and what not) and also we wouldn't have to deal with issues
like these:
- https://github.com/alshedivat/al-folio/issues/1520
- https://github.com/alshedivat/al-folio/issues/1491
This commit is contained in:
Amir Pourmand 2023-08-20 08:52:43 +03:30 committed by GitHub
parent 920cb69e15
commit 16a19434aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -155,14 +155,13 @@ Medical Robotics Junior Faculty Forum (ISMR: <a href="https://junior-forum-ismr.
## Table Of Contents
- [al-folio](#al-folio)
- [User community](#user-community)
- [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
- [Table Of Contents](#table-of-contents)
- [Getting started](#getting-started)
* [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)
- [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended)
- [Local Setup (Legacy)](#local-setup-legacy)
- [Deployment](#deployment)
- [Upgrading from a previous version](#upgrading-from-a-previous-version)
- [FAQ](#faq)
@ -204,18 +203,19 @@ $ cd <your-repo-name>
---
#### Local setup using Docker (Recommended on Windows)
#### Local setup using Docker (Recommended)
Using Docker to install Jekyll and Ruby dependencies is the easiest way.
You need to take the following steps to get `al-folio` up and running in your local machine:
You need to take the following steps to get `al-folio` up and running on your local machine:
- First, install [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/).
- Finally, run the following command that will pull a pre-built image from DockerHub and will run your website.
- Finally, run the following command that will pull the latest pre-built image from DockerHub and will run your website.
```bash
$ docker-compose up
```
Note that when you run it for the first time, it will download a docker image of size 300MB or so.
Note that when you run it for the first time, it will download a docker image of size 400MB or so.
Now, feel free to customize the theme however you like (don't forget to change the name!). After you are done, you can use the same command (`docker-compose up`) to render the webpage with all you changes. Also, make sure to commit your final changes.
@ -237,7 +237,7 @@ $ docker-compose -f docker-local.yml up
---
#### Local Setup (Standard)
#### Local Setup (Legacy)
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/)*).