florent/pages
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ADD More Clear Explanations in README (#1012)

Browse Source
This commit is contained in:
Amir Pourmand 2022-12-11 08:06:24 +03:30 committed by GitHub
parent cbd9698784
commit e78a622ac3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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.
<details><summary>(click to expand) <strong>Build your own docker image (more advanced):</strong></summary>
> To change port number, you can edit `docker-compose.yml` file.
<details><summary>(click to expand) <strong>Build your own docker image:</strong></summary>
> 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):
```bash
$ docker-compose -f docker-local.yml build
```
Run the website!
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.
</details>