diff --git a/.github/workflows/update-tocs.yml b/.github/workflows/update-tocs.yml index 6e06cfb..af69ff8 100644 --- a/.github/workflows/update-tocs.yml +++ b/.github/workflows/update-tocs.yml @@ -39,7 +39,7 @@ jobs: if [[ "$file" != *.md ]]; then continue fi - ./gh-md-toc --insert --no-backup --hide-footer $file + ./gh-md-toc --insert --no-backup --hide-footer --indent 2 $file done rm gh-md-toc diff --git a/CUSTOMIZE.md b/CUSTOMIZE.md index d67c8d4..832fd50 100644 --- a/CUSTOMIZE.md +++ b/CUSTOMIZE.md @@ -5,36 +5,37 @@ Here we will give you some tips on how to customize the website. One important t ## Table of Contents -* [Customize](#customize) - * [Table of Contents](#table-of-contents) - * [Project structure](#project-structure) - * [Configuration](#configuration) - * [Modifying the CV information](#modifying-the-cv-information) - * [Modifying the user and repository information](#modifying-the-user-and-repository-information) - * [Creating new pages](#creating-new-pages) - * [Creating new blog posts](#creating-new-blog-posts) - * [Creating new projects](#creating-new-projects) - * [Adding some news](#adding-some-news) - * [Adding Collections](#adding-collections) - * [Adding a new publication](#adding-a-new-publication) - * [Author annotation](#author-annotation) - * [Buttons (through custom bibtex keywords)](#buttons-through-custom-bibtex-keywords) - * [Changing theme color](#changing-theme-color) - * [Adding social media information](#adding-social-media-information) - * [Adding a newsletter](#adding-a-newsletter) - * [Removing content](#removing-content) - * [Removing the blog page](#removing-the-blog-page) - * [Removing the news section](#removing-the-news-section) - * [Removing the projects page](#removing-the-projects-page) - * [Removing the publications page](#removing-the-publications-page) - * [Removing the repositories page](#removing-the-repositories-page) - * [Adding Token for Lighthouse Badger](#adding-token-for-lighthouse-badger) - * [Personal Access Token (fine-grained) Permissions for Lighthouse Badger:](#personal-access-token-fine-grained-permissions-for-lighthouse-badger) - * [Customizing fonts, spacing, and more](#customizing-fonts-spacing-and-more) - * [Scheduled Posts](#scheduled-posts) - * [Name Format](#name-format) - * [Important Notes](#important-notes) - + +- [Customize](#customize) + - [Table of Contents](#table-of-contents) + - [Project structure](#project-structure) + - [Configuration](#configuration) + - [Modifying the CV information](#modifying-the-cv-information) + - [Modifying the user and repository information](#modifying-the-user-and-repository-information) + - [Creating new pages](#creating-new-pages) + - [Creating new blog posts](#creating-new-blog-posts) + - [Creating new projects](#creating-new-projects) + - [Adding some news](#adding-some-news) + - [Adding Collections](#adding-collections) + - [Adding a new publication](#adding-a-new-publication) + - [Author annotation](#author-annotation) + - [Buttons (through custom bibtex keywords)](#buttons-through-custom-bibtex-keywords) + - [Changing theme color](#changing-theme-color) + - [Adding social media information](#adding-social-media-information) + - [Adding a newsletter](#adding-a-newsletter) + - [Removing content](#removing-content) + - [Removing the blog page](#removing-the-blog-page) + - [Removing the news section](#removing-the-news-section) + - [Removing the projects page](#removing-the-projects-page) + - [Removing the publications page](#removing-the-publications-page) + - [Removing the repositories page](#removing-the-repositories-page) + - [Adding Token for Lighthouse Badger](#adding-token-for-lighthouse-badger) + - [Personal Access Token (fine-grained) Permissions for Lighthouse Badger:](#personal-access-token-fine-grained-permissions-for-lighthouse-badger) + - [Customizing fonts, spacing, and more](#customizing-fonts-spacing-and-more) + - [Scheduled Posts](#scheduled-posts) + _ [Name Format](#name-format) + _ [Important Notes](#important-notes) + ## Project structure diff --git a/FAQ.md b/FAQ.md index 2068140..a615276 100644 --- a/FAQ.md +++ b/FAQ.md @@ -5,25 +5,26 @@ Here are some frequently asked questions. If you have a different question, plea ## Table of Contents -* [Frequently Asked Questions](#frequently-asked-questions) - * [Table of Contents](#table-of-contents) - * [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) - * [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) - * [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) - * [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) - * [Atom feed doesn't work. Why?](#atom-feed-doesnt-work-why) - * [My site doesn't work when I enable related_blog_posts. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why) - * [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) - * [When I manually run the Lighthouse Badger 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) - * [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) - * [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) - * [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) - * [How can I update Academicons version on the template](#how-can-i-update-academicons-version-on-the-template) - * [How can I update Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template) - * [How can I update Tabler Icons version on the template](#how-can-i-update-tabler-icons-version-on-the-template) - * [What do all these GitHub actions/workflows mean?](#what-do-all-these-github-actionsworkflows-mean) - * [How can I use Google Search Console ID on the template?](#how-can-i-use-google-search-console-id-on-the-template) - + +- [Frequently Asked Questions](#frequently-asked-questions) + - [Table of Contents](#table-of-contents) + _ [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) + _ [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) + _ [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) + _ [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) + _ [Atom feed doesn't work. Why?](#atom-feed-doesnt-work-why) + _ [My site doesn't work when I enable related_blog_posts. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why) + _ [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) + _ [When I manually run the Lighthouse Badger 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) + _ [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) + _ [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) + _ [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) + _ [How can I update Academicons version on the template](#how-can-i-update-academicons-version-on-the-template) + _ [How can I update Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template) + _ [How can I update Tabler Icons version on the template](#how-can-i-update-tabler-icons-version-on-the-template) + _ [What do all these GitHub actions/workflows mean?](#what-do-all-these-github-actionsworkflows-mean) + _ [How can I use Google Search Console ID on the template?](#how-can-i-use-google-search-console-id-on-the-template) + --- diff --git a/INSTALL.md b/INSTALL.md index 4582f94..c8a3293 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,25 +1,26 @@ # Table of Contents -* [Table of Contents](#table-of-contents) -* [Installing and Deploying](#installing-and-deploying) - * [Recommended Approach](#recommended-approach) - * [Local setup on Windows](#local-setup-on-windows) - * [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended) - * [Build your own docker image](#build-your-own-docker-image) - * [Have Bugs on Docker Image?](#have-bugs-on-docker-image) - * [Local Setup with Development Containers](#local-setup-with-development-containers) - * [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported) - * [Deployment](#deployment) - * [For personal and organization webpages](#for-personal-and-organization-webpages) - * [For project pages](#for-project-pages) - * [Enabling automatic deployment](#enabling-automatic-deployment) - * [Manual deployment to GitHub Pages](#manual-deployment-to-github-pages) - * [Deploy on Netlify](https://www.netlify.com/) - * [Deployment to another hosting server (non GitHub Pages)](#deployment-to-another-hosting-server-non-github-pages) - * [Deployment to a separate repository (advanced users only)](#deployment-to-a-separate-repository-advanced-users-only) - * [Upgrading from a previous version](#upgrading-from-a-previous-version) - + +- [Table of Contents](#table-of-contents) +- [Installing and Deploying](#installing-and-deploying) + - [Recommended Approach](#recommended-approach) + - [Local setup on Windows](#local-setup-on-windows) + - [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended) + - [Build your own docker image](#build-your-own-docker-image) + - [Have Bugs on Docker Image?](#have-bugs-on-docker-image) + - [Local Setup with Development Containers](#local-setup-with-development-containers) + - [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported) + - [Deployment](#deployment) + - [For personal and organization webpages](#for-personal-and-organization-webpages) + - [For project pages](#for-project-pages) + - [Enabling automatic deployment](#enabling-automatic-deployment) + - [Manual deployment to GitHub Pages](#manual-deployment-to-github-pages) + - [Deploy on Netlify](https://www.netlify.com/) + - [Deployment to another hosting server (non GitHub Pages)](#deployment-to-another-hosting-server-non-github-pages) + - [Deployment to a separate repository (advanced users only)](#deployment-to-a-separate-repository-advanced-users-only) + - [Upgrading from a previous version](#upgrading-from-a-previous-version) + # Installing and Deploying diff --git a/README.md b/README.md index d48fcde..3439add 100644 --- a/README.md +++ b/README.md @@ -225,39 +225,40 @@ Run the test yourself: [Google Lighthouse PageSpeed Insights](https://pagespeed. ## Table Of Contents -* [al-folio](#al-folio) - * [User community](#user-community) - * [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights) - * [Desktop](#desktop) - * [Mobile](#mobile) - * [Table Of Contents](#table-of-contents) - * [Getting started](#getting-started) - * [Installing and Deploying](#installing-and-deploying) - * [Customizing](#customizing) - * [Features](#features) - * [Light/Dark Mode](#lightdark-mode) - * [CV](#cv) - * [People](#people) - * [Publications](#publications) - * [Collections](#collections) - * [Layouts](#layouts) - * [The iconic style of Distill](#the-iconic-style-of-distill) - * [Full support for math & code](#full-support-for-math--code) - * [Photos, Audio, Video and more](#photos-audio-video-and-more) - * [Other features](#other-features) - * [GitHub's repositories and user stats](#githubs-repositories-and-user-stats) - * [Theming](#theming) - * [Social media previews](#social-media-previews) - * [Atom (RSS-like) Feed](#atom-rss-like-feed) - * [Related posts](#related-posts) - * [Code quality checks](#code-quality-checks) - * [FAQ](#faq) - * [Contributing](#contributing) - * [Maintainers](#maintainers) - * [All Contributors](#all-contributors) - * [Star History](#star-history) - * [License](#license) - + +- [al-folio](#al-folio) + - [User community](#user-community) + - [Lighthouse PageSpeed Insights](#lighthouse-pagespeed-insights) + - [Desktop](#desktop) + - [Mobile](#mobile) + - [Table Of Contents](#table-of-contents) + - [Getting started](#getting-started) + - [Installing and Deploying](#installing-and-deploying) + - [Customizing](#customizing) + - [Features](#features) + - [Light/Dark Mode](#lightdark-mode) + - [CV](#cv) + - [People](#people) + - [Publications](#publications) + - [Collections](#collections) + - [Layouts](#layouts) + - [The iconic style of Distill](#the-iconic-style-of-distill) + - [Full support for math & code](#full-support-for-math--code) + - [Photos, Audio, Video and more](#photos-audio-video-and-more) + - [Other features](#other-features) + - [GitHub's repositories and user stats](#githubs-repositories-and-user-stats) + - [Theming](#theming) + - [Social media previews](#social-media-previews) + - [Atom (RSS-like) Feed](#atom-rss-like-feed) + - [Related posts](#related-posts) + - [Code quality checks](#code-quality-checks) + - [FAQ](#faq) + - [Contributing](#contributing) + - [Maintainers](#maintainers) + - [All Contributors](#all-contributors) + - [Star History](#star-history) + - [License](#license) + ## Getting started