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
-[After I create a new repository from this template and setup the repo, I get a deployment error. Isn't the website supposed to correctly deploy automatically?](#after-i-create-a-new-repository-from-this-template-and-setup-the-repo-i-get-a-deployment-error-isnt-the-website-supposed-to-correctly-deploy-automatically)
9
-
-[I am using a custom domain (e.g., foo.com). My custom domain becomes blank in the repository settings after each deployment. How do I fix that?](#i-am-using-a-custom-domain-eg-foocom-my-custom-domain-becomes-blank-in-the-repository-settings-after-each-deployment-how-do-i-fix-that)
10
-
-[My webpage works locally. But after deploying, it fails to build and throws Unknown tag 'toc'. How do I fix that?](#my-webpage-works-locally-but-after-deploying-it-fails-to-build-and-throws-unknown-tag-toc-how-do-i-fix-that)
9
+
-[I am using a custom domain (e.g., `foo.com`). My custom domain becomes blank in the repository settings after each deployment. How do I fix that?](#i-am-using-a-custom-domain-eg-foocom-my-custom-domain-becomes-blank-in-the-repository-settings-after-each-deployment-how-do-i-fix-that)
10
+
-[My webpage works locally. But after deploying, it fails to build and throws `Unknown tag 'toc'`. How do I fix that?](#my-webpage-works-locally-but-after-deploying-it-fails-to-build-and-throws-unknown-tag-toc-how-do-i-fix-that)
11
11
-[My webpage works locally. But after deploying, it is not displayed correctly (CSS and JS are not loaded properly). How do I fix that?](#my-webpage-works-locally-but-after-deploying-it-is-not-displayed-correctly-css-and-js-are-not-loaded-properly-how-do-i-fix-that)
-[My site doesn't work when I enable related_blog_posts. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why)
13
+
-[My site doesn't work when I enable `related_blog_posts`. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why)
14
14
-[When trying to deploy, it's asking for github login credentials, which github disabled password authentication and it exits with an error. How to fix?](#when-trying-to-deploy-its-asking-for-github-login-credentials-which-github-disabled-password-authentication-and-it-exits-with-an-error-how-to-fix)
15
-
-[When I manually run the Lighthouse Badger workflow, it fails with Error: Input required and not supplied: token. How do I fix that?](#when-i-manually-run-the-lighthouse-badger-workflow-it-fails-with-error-input-required-and-not-supplied-token-how-do-i-fix-that)
16
-
-[My code runs fine locally, but when I create a commit and submit it, it fails with prettier code formatter workflow run failed for main branch. How do I fix that?](#my-code-runs-fine-locally-but-when-i-create-a-commit-and-submit-it-it-fails-with-prettier-code-formatter-workflow-run-failed-for-main-branch-how-do-i-fix-that)
15
+
-[When I manually run the Lighthouse Badger workflow, it fails with `Error: Input required and not supplied: token`. How do I fix that?](#when-i-manually-run-the-lighthouse-badger-workflow-it-fails-with-error-input-required-and-not-supplied-token-how-do-i-fix-that)
16
+
-[My code runs fine locally, but when I create a commit and submit it, it fails with `prettier code formatter workflow run failed for main branch`. How do I fix that?](#my-code-runs-fine-locally-but-when-i-create-a-commit-and-submit-it-it-fails-with-prettier-code-formatter-workflow-run-failed-for-main-branch-how-do-i-fix-that)
17
17
-[After I update my site with some new content, even a small change, the GitHub action throws an error or displays a warning. What happened?](#after-i-update-my-site-with-some-new-content-even-a-small-change-the-github-action-throws-an-error-or-displays-a-warning-what-happened)
18
-
-[I am trying to deploy my site, but it fails with Could not find gem 'jekyll-diagrams' in locally installed gems. How do I fix that?](#i-am-trying-to-deploy-my-site-but-it-fails-with-could-not-find-gem-jekyll-diagrams-in-locally-installed-gems-how-do-i-fix-that)
18
+
-[I am trying to deploy my site, but it fails with `Could not find gem 'jekyll-diagrams' in locally installed gems`. How do I fix that?](#i-am-trying-to-deploy-my-site-but-it-fails-with-could-not-find-gem-jekyll-diagrams-in-locally-installed-gems-how-do-i-fix-that)
19
19
-[How can I update Academicons version on the template](#how-can-i-update-academicons-version-on-the-template)
20
20
-[How can I update Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template)
21
21
-[What do all these GitHub actions/workflows mean?](#what-do-all-these-github-actionsworkflows-mean)
See [Local setup using Docker](#local-setup-using-docker-recommended) or other sections below for local development options.
@@ -66,8 +66,8 @@ You need to take the following steps to get `al-folio` up and running on your lo
66
66
- Finally, run the following command that will pull the latest pre-built image from DockerHub and will run your website.
67
67
68
68
```bash
69
-
$ docker compose pull
70
-
$ docker compose up
69
+
docker compose pull
70
+
docker compose up
71
71
```
72
72
73
73
Note that when you run it for the first time, it will download a docker image of size 400MB or so. To see the template running, open your browser and go to `http://localhost:8080`. You should see a copy of the theme's demo website.
@@ -83,7 +83,7 @@ Now, feel free to customize the theme however you like (don't forget to change t
83
83
Build and run a new docker image using:
84
84
85
85
```bash
86
-
$ docker compose up --build
86
+
docker compose up --build
87
87
```
88
88
89
89
> 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 the previous command! It will download Ruby and Jekyll and install all Ruby packages again from scratch.
@@ -132,10 +132,10 @@ For a hands-on walkthrough of running al-folio locally without using Docker, che
132
132
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/)_).
133
133
134
134
```bash
135
-
$ bundle install
135
+
bundle install
136
136
# assuming pip is your Python package manager
137
-
$ pip install jupyter
138
-
$ bundle exec jekyll serve
137
+
pip install jupyter
138
+
bundle exec jekyll serve
139
139
```
140
140
141
141
To see the template running, open your browser and go to `http://localhost:4000`. You should see a copy of the theme's [demo website](https://alshedivat.github.io/al-folio/). Now, feel free to customize the theme however you like. After you are done, remember to **commit** your final changes.
@@ -197,7 +197,7 @@ If you need to manually re-deploy your website to GitHub pages, go to Actions, c
197
197
If you decide to not use GitHub Pages and host your page elsewhere, simply run:
198
198
199
199
```bash
200
-
$ bundle exec jekyll build
200
+
bundle exec jekyll build
201
201
```
202
202
203
203
which will (re-)generate the static webpage in the `_site/` folder.
@@ -206,7 +206,7 @@ Then simply copy the contents of the `_site/` directory to your hosting server.
206
206
If you also want to remove unused css classes from your file, run:
207
207
208
208
```bash
209
-
$ purgecss -c purgecss.config.js
209
+
purgecss -c purgecss.config.js
210
210
```
211
211
212
212
which will replace the css files in the `_site/assets/css/` folder with the purged css files.
@@ -225,7 +225,7 @@ Firstly, from the deployment repo dir, checkout the git branch hosting your publ
225
225
Then from the website sources dir (commonly your al-folio fork's clone):
0 commit comments