Skip to content

Commit 4b590b6

Browse files
george-gcaOmidSa75
george-gca
authored and
OmidSa75
committed
Fixed tocs (alshedivat#3133)
Signed-off-by: George Araújo <[email protected]>
1 parent 966eadb commit 4b590b6

File tree

5 files changed

+106
-102
lines changed

5 files changed

+106
-102
lines changed

‎.github/workflows/update-tocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
if [[ "$file" != *.md ]]; then
4040
continue
4141
fi
42-
./gh-md-toc --insert --no-backup --hide-footer $file
42+
./gh-md-toc --insert --no-backup --hide-footer --indent 2 $file
4343
done
4444
rm gh-md-toc
4545

‎CUSTOMIZE.md

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,37 @@ Here we will give you some tips on how to customize the website. One important t
55
## Table of Contents
66

77
<!--ts-->
8-
* [Customize](#customize)
9-
* [Table of Contents](#table-of-contents)
10-
* [Project structure](#project-structure)
11-
* [Configuration](#configuration)
12-
* [Modifying the CV information](#modifying-the-cv-information)
13-
* [Modifying the user and repository information](#modifying-the-user-and-repository-information)
14-
* [Creating new pages](#creating-new-pages)
15-
* [Creating new blog posts](#creating-new-blog-posts)
16-
* [Creating new projects](#creating-new-projects)
17-
* [Adding some news](#adding-some-news)
18-
* [Adding Collections](#adding-collections)
19-
* [Adding a new publication](#adding-a-new-publication)
20-
* [Author annotation](#author-annotation)
21-
* [Buttons (through custom bibtex keywords)](#buttons-through-custom-bibtex-keywords)
22-
* [Changing theme color](#changing-theme-color)
23-
* [Adding social media information](#adding-social-media-information)
24-
* [Adding a newsletter](#adding-a-newsletter)
25-
* [Removing content](#removing-content)
26-
* [Removing the blog page](#removing-the-blog-page)
27-
* [Removing the news section](#removing-the-news-section)
28-
* [Removing the projects page](#removing-the-projects-page)
29-
* [Removing the publications page](#removing-the-publications-page)
30-
* [Removing the repositories page](#removing-the-repositories-page)
31-
* [Adding Token for Lighthouse Badger](#adding-token-for-lighthouse-badger)
32-
* [Personal Access Token (fine-grained) Permissions for Lighthouse Badger:](#personal-access-token-fine-grained-permissions-for-lighthouse-badger)
33-
* [Customizing fonts, spacing, and more](#customizing-fonts-spacing-and-more)
34-
* [Scheduled Posts](#scheduled-posts)
35-
* [Name Format](#name-format)
36-
* [Important Notes](#important-notes)
37-
<!--te-->
8+
9+
- [Customize](#customize)
10+
- [Table of Contents](#table-of-contents)
11+
- [Project structure](#project-structure)
12+
- [Configuration](#configuration)
13+
- [Modifying the CV information](#modifying-the-cv-information)
14+
- [Modifying the user and repository information](#modifying-the-user-and-repository-information)
15+
- [Creating new pages](#creating-new-pages)
16+
- [Creating new blog posts](#creating-new-blog-posts)
17+
- [Creating new projects](#creating-new-projects)
18+
- [Adding some news](#adding-some-news)
19+
- [Adding Collections](#adding-collections)
20+
- [Adding a new publication](#adding-a-new-publication)
21+
- [Author annotation](#author-annotation)
22+
- [Buttons (through custom bibtex keywords)](#buttons-through-custom-bibtex-keywords)
23+
- [Changing theme color](#changing-theme-color)
24+
- [Adding social media information](#adding-social-media-information)
25+
- [Adding a newsletter](#adding-a-newsletter)
26+
- [Removing content](#removing-content)
27+
- [Removing the blog page](#removing-the-blog-page)
28+
- [Removing the news section](#removing-the-news-section)
29+
- [Removing the projects page](#removing-the-projects-page)
30+
- [Removing the publications page](#removing-the-publications-page)
31+
- [Removing the repositories page](#removing-the-repositories-page)
32+
- [Adding Token for Lighthouse Badger](#adding-token-for-lighthouse-badger)
33+
- [Personal Access Token (fine-grained) Permissions for Lighthouse Badger:](#personal-access-token-fine-grained-permissions-for-lighthouse-badger)
34+
- [Customizing fonts, spacing, and more](#customizing-fonts-spacing-and-more)
35+
- [Scheduled Posts](#scheduled-posts)
36+
_ [Name Format](#name-format)
37+
_ [Important Notes](#important-notes)
38+
<!--te-->
3839

3940
## Project structure
4041

‎FAQ.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,26 @@ Here are some frequently asked questions. If you have a different question, plea
55
## Table of Contents
66

77
<!--ts-->
8-
* [Frequently Asked Questions](#frequently-asked-questions)
9-
* [Table of Contents](#table-of-contents)
10-
* [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)
11-
* [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)
12-
* [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)
13-
* [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)
14-
* [Atom feed doesn't work. Why?](#atom-feed-doesnt-work-why)
15-
* [My site doesn't work when I enable related_blog_posts. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why)
16-
* [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)
17-
* [When I manually run the <a href="https://github.com/alshedivat/al-folio/actions/workflows/lighthouse-badger.yml">Lighthouse Badger</a> workflow, it fails with Error: Input required and not supplied: token. How do I fix that?](https://github.com/alshedivat/al-folio/actions/workflows/lighthouse-badger.yml)
18-
* [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)
19-
* [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)
20-
* [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)
21-
* [How can I update Academicons version on the template](#how-can-i-update-academicons-version-on-the-template)
22-
* [How can I update Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template)
23-
* [How can I update Tabler Icons version on the template](#how-can-i-update-tabler-icons-version-on-the-template)
24-
* [What do all these GitHub actions/workflows mean?](#what-do-all-these-github-actionsworkflows-mean)
25-
* [How can I use Google Search Console ID on the template?](#how-can-i-use-google-search-console-id-on-the-template)
26-
<!--te-->
8+
9+
- [Frequently Asked Questions](#frequently-asked-questions)
10+
- [Table of Contents](#table-of-contents)
11+
_ [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)
12+
_ [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)
13+
_ [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)
14+
_ [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)
15+
_ [Atom feed doesn't work. Why?](#atom-feed-doesnt-work-why)
16+
_ [My site doesn't work when I enable related_blog_posts. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why)
17+
_ [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)
18+
_ [When I manually run the <a href="https://github.com/alshedivat/al-folio/actions/workflows/lighthouse-badger.yml">Lighthouse Badger</a> workflow, it fails with Error: Input required and not supplied: token. How do I fix that?](https://github.com/alshedivat/al-folio/actions/workflows/lighthouse-badger.yml)
19+
_ [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)
20+
_ [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)
21+
_ [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)
22+
_ [How can I update Academicons version on the template](#how-can-i-update-academicons-version-on-the-template)
23+
_ [How can I update Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template)
24+
_ [How can I update Tabler Icons version on the template](#how-can-i-update-tabler-icons-version-on-the-template)
25+
_ [What do all these GitHub actions/workflows mean?](#what-do-all-these-github-actionsworkflows-mean)
26+
_ [How can I use Google Search Console ID on the template?](#how-can-i-use-google-search-console-id-on-the-template)
27+
<!--te-->
2728

2829
---
2930

‎INSTALL.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
11
# Table of Contents
22

33
<!--ts-->
4-
* [Table of Contents](#table-of-contents)
5-
* [Installing and Deploying](#installing-and-deploying)
6-
* [Recommended Approach](#recommended-approach)
7-
* [Local setup on Windows](#local-setup-on-windows)
8-
* [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended)
9-
* [Build your own docker image](#build-your-own-docker-image)
10-
* [Have Bugs on Docker Image?](#have-bugs-on-docker-image)
11-
* [Local Setup with Development Containers](#local-setup-with-development-containers)
12-
* [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported)
13-
* [Deployment](#deployment)
14-
* [For personal and organization webpages](#for-personal-and-organization-webpages)
15-
* [For project pages](#for-project-pages)
16-
* [Enabling automatic deployment](#enabling-automatic-deployment)
17-
* [Manual deployment to GitHub Pages](#manual-deployment-to-github-pages)
18-
* [Deploy on <a href="https://www.netlify.com/" rel="nofollow">Netlify</a>](https://www.netlify.com/)
19-
* [Deployment to another hosting server (non GitHub Pages)](#deployment-to-another-hosting-server-non-github-pages)
20-
* [Deployment to a separate repository (advanced users only)](#deployment-to-a-separate-repository-advanced-users-only)
21-
* [Upgrading from a previous version](#upgrading-from-a-previous-version)
22-
<!--te-->
4+
5+
- [Table of Contents](#table-of-contents)
6+
- [Installing and Deploying](#installing-and-deploying)
7+
- [Recommended Approach](#recommended-approach)
8+
- [Local setup on Windows](#local-setup-on-windows)
9+
- [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended)
10+
- [Build your own docker image](#build-your-own-docker-image)
11+
- [Have Bugs on Docker Image?](#have-bugs-on-docker-image)
12+
- [Local Setup with Development Containers](#local-setup-with-development-containers)
13+
- [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported)
14+
- [Deployment](#deployment)
15+
- [For personal and organization webpages](#for-personal-and-organization-webpages)
16+
- [For project pages](#for-project-pages)
17+
- [Enabling automatic deployment](#enabling-automatic-deployment)
18+
- [Manual deployment to GitHub Pages](#manual-deployment-to-github-pages)
19+
- [Deploy on <a href="https://www.netlify.com/" rel="nofollow">Netlify</a>](https://www.netlify.com/)
20+
- [Deployment to another hosting server (non GitHub Pages)](#deployment-to-another-hosting-server-non-github-pages)
21+
- [Deployment to a separate repository (advanced users only)](#deployment-to-a-separate-repository-advanced-users-only)
22+
- [Upgrading from a previous version](#upgrading-from-a-previous-version)
23+
<!--te-->
2324

2425
# Installing and Deploying
2526

‎README.md

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -225,39 +225,40 @@ Run the test yourself: [Google Lighthouse PageSpeed Insights](https://pagespeed.
225225
## Table Of Contents
226226

227227
<!--ts-->
228-
* [al-folio](#al-folio)
229-
* [User community](#user-community)
230-
* [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
231-
* [Desktop](#desktop)
232-
* [Mobile](#mobile)
233-
* [Table Of Contents](#table-of-contents)
234-
* [Getting started](#getting-started)
235-
* [Installing and Deploying](#installing-and-deploying)
236-
* [Customizing](#customizing)
237-
* [Features](#features)
238-
* [Light/Dark Mode](#lightdark-mode)
239-
* [CV](#cv)
240-
* [People](#people)
241-
* [Publications](#publications)
242-
* [Collections](#collections)
243-
* [Layouts](#layouts)
244-
* [The iconic style of Distill](#the-iconic-style-of-distill)
245-
* [Full support for math &amp; code](#full-support-for-math--code)
246-
* [Photos, Audio, Video and more](#photos-audio-video-and-more)
247-
* [Other features](#other-features)
248-
* [GitHub's repositories and user stats](#githubs-repositories-and-user-stats)
249-
* [Theming](#theming)
250-
* [Social media previews](#social-media-previews)
251-
* [Atom (RSS-like) Feed](#atom-rss-like-feed)
252-
* [Related posts](#related-posts)
253-
* [Code quality checks](#code-quality-checks)
254-
* [FAQ](#faq)
255-
* [Contributing](#contributing)
256-
* [Maintainers](#maintainers)
257-
* [All Contributors](#all-contributors)
258-
* [Star History](#star-history)
259-
* [License](#license)
260-
<!--te-->
228+
229+
- [al-folio](#al-folio)
230+
- [User community](#user-community)
231+
- [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights)
232+
- [Desktop](#desktop)
233+
- [Mobile](#mobile)
234+
- [Table Of Contents](#table-of-contents)
235+
- [Getting started](#getting-started)
236+
- [Installing and Deploying](#installing-and-deploying)
237+
- [Customizing](#customizing)
238+
- [Features](#features)
239+
- [Light/Dark Mode](#lightdark-mode)
240+
- [CV](#cv)
241+
- [People](#people)
242+
- [Publications](#publications)
243+
- [Collections](#collections)
244+
- [Layouts](#layouts)
245+
- [The iconic style of Distill](#the-iconic-style-of-distill)
246+
- [Full support for math &amp; code](#full-support-for-math--code)
247+
- [Photos, Audio, Video and more](#photos-audio-video-and-more)
248+
- [Other features](#other-features)
249+
- [GitHub's repositories and user stats](#githubs-repositories-and-user-stats)
250+
- [Theming](#theming)
251+
- [Social media previews](#social-media-previews)
252+
- [Atom (RSS-like) Feed](#atom-rss-like-feed)
253+
- [Related posts](#related-posts)
254+
- [Code quality checks](#code-quality-checks)
255+
- [FAQ](#faq)
256+
- [Contributing](#contributing)
257+
- [Maintainers](#maintainers)
258+
- [All Contributors](#all-contributors)
259+
- [Star History](#star-history)
260+
- [License](#license)
261+
<!--te-->
261262

262263
## Getting started
263264

0 commit comments

Comments
 (0)