Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ADD More Clear Explanations in README #1012

Merged
merged 2 commits into from
Dec 11, 2022
Merged

ADD More Clear Explanations in README #1012

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61c0a6d
add more clear explanations
pourmand1376 Dec 5, 2022
49c8ea2
Update README.md
pourmand1376 Dec 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 5 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,26 +188,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>

> 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.

<details><summary>(click to expand) <strong>Build your own docker image:</strong></summary>

```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.

</details>

Expand Down