Skip to content

Commit 09c8781

Browse files
authored
Update README.md
1 parent c7736d6 commit 09c8781

File tree

1 file changed

+39
-17
lines changed

1 file changed

+39
-17
lines changed

README.md

+39-17
Original file line numberDiff line numberDiff line change
@@ -113,53 +113,63 @@ Neural Compression (ICLR: <a href="https://neuralcompression.github.io/" target=
113113

114114
## Getting started
115115

116-
For more about how to use Jekyll, check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/).
116+
Want to learn more about Jekyll? Check out [this tutorial](https://www.taniarascia.com/make-a-static-website-with-jekyll/).
117117
Why Jekyll? Read [Andrej Karpathy's blog post](https://karpathy.github.io/2014/07/01/switching-to-jekyll/)!
118118

119119

120120
### Installation
121121

122+
For a hands-on walkthrough al-folio installation, check out [this cool video tutorial](https://www.youtube.com/watch?v=g6AJ9qPPoyc) by one of the community members! 🎬 🍿
123+
124+
---
125+
122126
#### Local setup using Docker (Recommended on Windows)
123127

124-
You need to do these step to get `al-folio` up and running in your local machine:
128+
You need to take the following steps to get `al-folio` up and running in your local machine:
125129

126-
- Install [docker](https://docs.docker.com/get-docker/)
127-
- Clone your repository
130+
- First, [install docker](https://docs.docker.com/get-docker/)
131+
- Then, clone this repository to your machine:
128132

129133
```bash
130-
git clone git@github.com:<your-username>/<your-repo-name>.git
131-
cd <your-repo-name>
134+
$ git clone git@github.com:<your-username>/<your-repo-name>.git
135+
$ cd <your-repo-name>
132136
```
133137

134-
Then you can use Dockerhub prebuilt image to run your website. Note that for the first time it would download an image of size 300MB or so.
138+
Finally, run the following command that will pull a pre-built image from DockerHub and will run your website.
135139

136140
```bash
137-
bin/dockerhub_run.sh
141+
$ ./bin/dockerhub_run.sh
138142
```
139143

140-
> Currently, you should opt this method, only if you are using newest version of al-folio. If you are using an old version. You should build your own image.
144+
Note that when you run it for the first time, it will download a docker image of size 300MB or so.
145+
146+
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 (`bin/dockerhub_run.sh`) to render the webpage with all you changes. Also, make sure to commit your final changes.
141147

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

150+
> Note: this approach is only necessary if you would like to build an older or very custom version of al-folio.
151+
144152
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):
145153

146154

147-
\```bash
148-
bin/docker_build_image.sh
149-
\```
155+
```bash
156+
$ ./bin/docker_build_image.sh
157+
```
150158

151159
Run the website!
152160

153-
\```bash
154-
bin/docker_run.sh
155-
\```
161+
```bash
162+
$ ./bin/docker_run.sh
163+
```
156164

157165
> To change port number, you can edit `docker_run.sh` file.
158166
159167
> If you want to update jekyll, install new ruby packages, etc., all you have to do is build the image again using `docker_build_image.sh`! It will download ruby and jekyll and install all ruby packages again from scratch.
160168
161169
</details>
162170

171+
---
172+
163173
#### Local Setup (Standard)
164174

165175
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)*), first [fork](https://guides.github.com/activities/forking/) the theme from `github.com:alshedivat/al-folio` to `github.com:<your-username>/<your-repo-name>` and do the following:
@@ -174,6 +184,8 @@ $ bundle exec jekyll serve
174184
Now, feel free to customize the theme however you like (don't forget to change the name!).
175185
After you are done, **commit** your final changes.
176186

187+
---
188+
177189
#### Deployment
178190

179191
Deploying your website to [GitHub Pages](https://pages.github.com/) is the most popular option.
@@ -255,6 +267,8 @@ In its default configuration, al-folio will copy the top-level `README.md` to th
255267

256268
</details>
257269

270+
---
271+
258272
#### Upgrading from a previous version
259273

260274
If you installed **al-folio** as described above, you can upgrade to the latest version as follows:
@@ -271,6 +285,8 @@ You can still follow the steps above, but `git rebase` may result in merge confl
271285
See [git rebase manual](https://help.github.com/en/github/using-git/about-git-rebase) and how to [resolve conflicts](https://help.github.com/en/github/using-git/resolving-merge-conflicts-after-a-git-rebase) for more information.
272286
If rebasing is too complicated, we recommend to re-install the new version of the theme from scratch and port over your content and changes from the previous version manually.
273287

288+
---
289+
274290
### FAQ
275291

276292
Here are some frequently asked questions.
@@ -304,6 +320,7 @@ If you have a different question, please ask using [Discussions](https://github.
304320
RSS Feed plugin works with these correctly set up fields: `title`, `url`, `description` and `author`.
305321
Make sure to fill them in an appropriate way and try again.
306322

323+
307324
## Features
308325

309326
### Publications
@@ -369,7 +386,9 @@ There are several custom bibtex keywords that you can use to affect how the entr
369386
You can implement your own buttons by editing the bib.html file.
370387

371388
</details>
372-
389+
390+
---
391+
373392
### Collections
374393

375394
This Jekyll theme implements `collections` to let you break up your work into categories.
@@ -381,7 +400,9 @@ Items from the `projects` collection are displayed on a responsive grid on proje
381400

382401
You can easily create your own collections, apps, short stories, courses, or whatever your creative work is.
383402
To do this, edit the collections in the `_config.yml` file, create a corresponding folder, and create a landing page for your collection, similar to `_pages/projects.md`.
384-
403+
404+
---
405+
385406
### Layouts
386407

387408
**al-folio** comes with stylish layouts for pages and blog posts.
@@ -414,6 +435,7 @@ Easily create beautiful grids within your blog posts and project pages:
414435
</a>
415436
</p>
416437

438+
---
417439

418440
### Other features
419441

0 commit comments

Comments
 (0)