Skip to content

Commit dfe4091

Browse files
george-gcagithub-actions[bot]
authored andcommitted
Auto update markdown TOC
1 parent 91a2b63 commit dfe4091

File tree

4 files changed

+96
-0
lines changed

4 files changed

+96
-0
lines changed

CUSTOMIZE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,35 @@ 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)
837
<!--te-->
938

1039
## Project structure

FAQ.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,23 @@
33
Here are some frequently asked questions. If you have a different question, please check if it was not already answered in the Q&A section of the [GitHub Discussions](https://github.com/alshedivat/al-folio/discussions/categories/q-a). If not, feel free to ask a new question there.
44

55
<!--ts-->
6+
* [Frequently Asked Questions](#frequently-asked-questions)
7+
* [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)
8+
* [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)
9+
* [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)
10+
* [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)
11+
* [Atom feed doesn't work. Why?](#atom-feed-doesnt-work-why)
12+
* [My site doesn't work when I enable related_blog_posts. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why)
13+
* [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)
14+
* [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)
15+
* [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)
16+
* [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)
17+
* [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+
* [How can I update Academicons version on the template](#how-can-i-update-academicons-version-on-the-template)
19+
* [How can I update Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template)
20+
* [How can I update Tabler Icons version on the template](#how-can-i-update-tabler-icons-version-on-the-template)
21+
* [What do all these GitHub actions/workflows mean?](#what-do-all-these-github-actionsworkflows-mean)
22+
* [How can I use Google Search Console ID on the template?](#how-can-i-use-google-search-console-id-on-the-template)
623
<!--te-->
724

825
---

INSTALL.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,24 @@
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)
422
<!--te-->
523

624
# Installing and Deploying

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,38 @@ 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)
228260
<!--te-->
229261

230262
## Getting started

0 commit comments

Comments
 (0)