add TOC to FAQ

TelegramBots · Jul 23, 2024 · d72269c · d72269c
1 parent a668ab1
commit d72269c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -23,7 +23,7 @@ jobs:
       with:
         tool: mdbook,cargo-binstall
     - name: Install mdbook extensions
-      run: cargo binstall -y mdbook-mermaid mdbook-alerts
+      run: cargo binstall -y mdbook-mermaid mdbook-alerts mdbook-toc
 
     # - name: Setup mdBook
     #   uses: peaceiris/actions-mdbook@v2

diff --git a/book.toml b/book.toml
@@ -11,3 +11,7 @@ git-repository-url = "https://github.com/TelegramBots/book"
 additional-css = ["theme/custom.css"]
 
 [preprocessor.alerts]
+
+[preprocessor.toc]
+command = "mdbook-toc"
+renderer = ["html"]
diff --git a/src/FAQ.md b/src/FAQ.md
@@ -2,6 +2,8 @@
 
 I recommend you read all of these as you will learn many interesting things. Or you can use Ctrl-F to search for a specific topic.
 
+<!-- toc -->
+
 ### _1. Can you give me documentation/examples links?_
 - Follow [this installation guide](https://telegrambots.github.io/book/#-installation) to install the latest versions of the library.
 - Here is on the [main documentation website](https://telegrambots.github.io/book/).