Skip to content

Commit 9149ab0

Browse files
committed
Removed $ from bash instructions
Signed-off-by: George Araújo <george.gcac@gmail.com>
1 parent c4c6643 commit 9149ab0

File tree

4 files changed

+25
-22
lines changed

4 files changed

+25
-22
lines changed

FAQ.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ Here are some frequently asked questions. If you have a different question, plea
66

77
- [Frequently Asked Questions](#frequently-asked-questions)
88
- [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)
1111
- [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)
1212
- [Atom feed doesn't work. Why?](#atom-feed-doesnt-work-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)
13+
- [My site doesn't work when I enable `related_blog_posts`. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why)
1414
- [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)
1717
- [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)
1919
- [How can I update Academicons version on the template](#how-can-i-update-academicons-version-on-the-template)
2020
- [How can I update Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template)
2121
- [What do all these GitHub actions/workflows mean?](#what-do-all-these-github-actionsworkflows-mean)

INSTALL.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0
4747
Once everything is deployed, you can download the repository to your machine and start customizing it locally:
4848

4949
```bash
50-
$ git clone git@github.com:<your-username>/<your-repo-name>.git
50+
git clone git@github.com:<your-username>/<your-repo-name>.git
5151
```
5252

5353
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
6666
- Finally, run the following command that will pull the latest pre-built image from DockerHub and will run your website.
6767

6868
```bash
69-
$ docker compose pull
70-
$ docker compose up
69+
docker compose pull
70+
docker compose up
7171
```
7272

7373
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
8383
Build and run a new docker image using:
8484

8585
```bash
86-
$ docker compose up --build
86+
docker compose up --build
8787
```
8888

8989
> 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
132132
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/)_).
133133

134134
```bash
135-
$ bundle install
135+
bundle install
136136
# 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
139139
```
140140

141141
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
197197
If you decide to not use GitHub Pages and host your page elsewhere, simply run:
198198

199199
```bash
200-
$ bundle exec jekyll build
200+
bundle exec jekyll build
201201
```
202202

203203
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.
206206
If you also want to remove unused css classes from your file, run:
207207

208208
```bash
209-
$ purgecss -c purgecss.config.js
209+
purgecss -c purgecss.config.js
210210
```
211211

212212
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
225225
Then from the website sources dir (commonly your al-folio fork's clone):
226226

227227
```bash
228-
$ bundle exec jekyll build --destination $HOME/repo/publishing-source
228+
bundle exec jekyll build --destination $HOME/repo/publishing-source
229229
```
230230

231231
This will instruct jekyll to deploy the website under `$HOME/repo/publishing-source`.
@@ -252,7 +252,7 @@ In its default configuration, al-folio will copy the top-level `README.md` to th
252252
**Quick reference:**
253253

254254
```bash
255-
$ bundle update --all
255+
bundle update --all
256256
```
257257

258258
After updating, test locally to ensure everything still works. If your site fails after updating, check the [FAQ](FAQ.md) for troubleshooting.
@@ -263,9 +263,9 @@ If you installed **al-folio** as described above, you can manually update your c
263263

264264
```bash
265265
# Assuming the current directory is <your-repo-name>
266-
$ git remote add upstream https://github.com/alshedivat/al-folio.git
267-
$ git fetch upstream
268-
$ git rebase v0.16.3
266+
git remote add upstream https://github.com/alshedivat/al-folio.git
267+
git fetch upstream
268+
git rebase v0.16.3
269269
```
270270

271271
If you have extensively customized a previous version, it might be trickier to upgrade.

SEO.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ This guide helps you optimize your al-folio website for search engines so your r
3333
- [SEO Checklist](#seo-checklist)
3434
- [Resources](#resources)
3535

36+
<!--te-->
37+
3638
## Overview
3739

3840
SEO (Search Engine Optimization) makes your website discoverable on Google, Bing, and other search engines. For academics, this means:

TROUBLESHOOTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide covers common issues and their solutions. For more information, see [
1313
- [Docker build fails](#docker-build-fails)
1414
- [Ruby dependency issues](#ruby-dependency-issues)
1515
- [Port already in use](#port-already-in-use)
16-
- [Styling & Layout Problems](#styling--layout-problems)
16+
- [Styling \& Layout Problems](#styling--layout-problems)
1717
- [CSS and JS not loading properly](#css-and-js-not-loading-properly)
1818
- [Site looks broken after deployment](#site-looks-broken-after-deployment)
1919
- [Theme colors not applying](#theme-colors-not-applying)
@@ -30,7 +30,8 @@ This guide covers common issues and their solutions. For more information, see [
3030
- [Related posts broken](#related-posts-broken)
3131
- [Code formatting issues](#code-formatting-issues)
3232
- [Getting Help](#getting-help)
33-
<!--te-->
33+
34+
<!--te-->
3435

3536
## Deployment Issues
3637

0 commit comments

Comments
 (0)