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
Update README to make Docker Recommended way (alshedivat#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:
- alshedivat#1520
- alshedivat#1491
-[Local setup using Docker (Recommended on Windows)](#local-setup-using-docker-recommended-on-windows)
165
-
-[Local Setup (Standard)](#local-setup-standard)
163
+
-[Local setup using Docker (Recommended)](#local-setup-using-docker-recommended)
164
+
-[Local Setup (Legacy)](#local-setup-legacy)
166
165
-[Deployment](#deployment)
167
166
-[Upgrading from a previous version](#upgrading-from-a-previous-version)
168
167
-[FAQ](#faq)
@@ -204,18 +203,19 @@ $ cd <your-repo-name>
204
203
205
204
---
206
205
207
-
#### Local setup using Docker (Recommended on Windows)
206
+
#### Local setup using Docker (Recommended)
207
+
Using Docker to install Jekyll and Ruby dependencies is the easiest way.
208
208
209
-
You need to take the following steps to get `al-folio` up and running in your local machine:
209
+
You need to take the following steps to get `al-folio` up and running on your local machine:
210
210
211
211
- First, install [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/).
212
-
- Finally, run the following command that will pull a pre-built image from DockerHub and will run your website.
212
+
- Finally, run the following command that will pull the latest pre-built image from DockerHub and will run your website.
213
213
214
214
```bash
215
215
$ docker-compose up
216
216
```
217
217
218
-
Note that when you run it for the first time, it will download a docker image of size 300MB or so.
218
+
Note that when you run it for the first time, it will download a docker image of size 400MB or so.
219
219
220
220
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.
221
221
@@ -237,7 +237,7 @@ $ docker-compose -f docker-local.yml up
237
237
238
238
---
239
239
240
-
#### Local Setup (Standard)
240
+
#### Local Setup (Legacy)
241
241
242
242
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/)*).
0 commit comments