From 2e12e70418445f4fcb7aea6fc15269a47d05e3a8 Mon Sep 17 00:00:00 2001 From: Amir Pourmand Date: Sun, 11 Dec 2022 08:06:24 +0330 Subject: [PATCH] ADD More Clear Explanations in README (#1012) --- README.md | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 06b549cf1966..c18ef5c873bb 100644 --- a/README.md +++ b/README.md @@ -189,26 +189,17 @@ Note that when you run it for the first time, it will download a docker image of 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. -
(click to expand) Build your own docker image (more advanced): - -> Note: this approach is only necessary if you would like to build an older or very custom version of al-folio. - -First, download the necessary modules and install them into a docker image called `al-folio:Dockerfile` (this command will build an image which is used to run your website afterwards. Note that you only need to do this step once. After you have the image, you no longer need to do this anymore): +> To change port number, you can edit `docker-compose.yml` file. +
(click to expand) Build your own docker image: -```bash -$ docker-compose -f docker-local.yml build -``` - -Run the website! +> Note: this approach is only necessary if you would like to build an older or very custom version of al-folio. +Build and run a new docker image using: ```bash $ docker-compose -f docker-local.yml up ``` - -> To change port number, you can edit `docker-compose.yml` file. - -> If you want to update jekyll, install new ruby packages, etc., all you have to do is build the image again! It will download ruby and jekyll and install all ruby packages again from scratch. +> If you want to update jekyll, install new ruby packages, etc., all you have to do is build the image again using `--force-recreate` argument at the end of previous command! It will download ruby and jekyll and install all ruby packages again from scratch.