feat: anchor for Example block

Author: MC-XiaoHei

docs/.vitepress/config.mts

@@ -6,6 +6,7 @@ import {VitePressI18nOptions} from 'vitepress-i18n/dist/types';
 import {VitePressSidebarOptions, withSidebar} from "vitepress-sidebar";
 import {tabsPlugin} from "./theme/tabs/codesMarkdownPlugin";
 import fs from "fs";
+import {exampleAutoAnchorPreprocessor} from "./theme/anchor/exampleAutoAnchorPreprocessor";
 
 const defaultLocale: string = 'en';
 const supportLocales: string[] = [defaultLocale, 'zhHans'];
@@ -92,7 +93,8 @@ const vitepressOptions: UserConfig = {
             })
         },
         config: (md) => {
-            tabsPlugin(md)
+            tabsPlugin(md);
+            exampleAutoAnchorPreprocessor(md);
         }
     }
 }

docs/.vitepress/theme/anchor/exampleAutoAnchorPreprocessor.ts

@@ -0,0 +1,24 @@
+import MarkdownIt from "markdown-it";
+import slugify from "@sindresorhus/slugify";
+
+export const exampleAutoAnchorPreprocessor = (md: MarkdownIt) => {
+    md.core.ruler.before('normalize', 'example-auto-anchor', (state) => {
+        const lines = state.src.split("\n");
+        const processedLines = lines.map((line) => {
+            if (line.startsWith(":::") && (line.includes(":::tip Example") || line.includes("::: tip Example"))) {
+                const title = line.split(/tip (.+)/)[1]
+                return `
+<div style="height: 0; color: rgba(0,0,0,0%);position: relative;top: 50px">
+<h3 id="${slugify(title.replace(" – ", ""))}">${title}</h3>                
+</div>
+
+${line}
+`;
+            } else {
+                return line;
+            }
+        });
+        state.src = processedLines.join("\n");
+    });
+}
+

docs/en/create-commands/arguments/types/chat/spigot-chat-arguments.md

@@ -74,7 +74,7 @@ This is converted into Spigot's `BaseComponent[]`, which can be used for the fol
   sender.spigot().sendMessage(BaseComponent[]);
   ```
 
-::::tip Example - Book made from raw JSON
+::::tip Example – Book made from raw JSON
 
 Say we want to generate a book using raw JSON. For this example, we'll use the following JSON (generated from [minecraftjson.com](https://minecraftjson.com/)) to generate our book:
 

docs/en/user-setup/command-conversion/conversion.md

@@ -49,7 +49,7 @@ If you're uncertain if your configuration is valid (or you're getting weird erro
 
 To convert all the commands that a plugin has, add the name of the plugin, followed by a `~` character to the list of plugins to convert in the `config.yml` file.
 
-::: tip **Example – Converting all commands from EssentialsX**
+::: tip Example – Converting all commands from EssentialsX
 
 For example, if you wanted to convert all commands that [EssentialsX](https://www.spigotmc.org/resources/essentialsx.9089/) has, you can use the following `config.yml`:
 

docs/en/user-setup/command-conversion/single-command.md

@@ -17,7 +17,7 @@ The CommandAPI has two ways of doing this:
 
 To convert a single command, you need to first populate the `config.yml` with the name of the plugin and commands to be converted. To illustrate this, we'll use an example:
 
-::: tip Example - Converting plugin commands
+::::tip Example – Converting plugin commands
 
 Say we're using [EssentialsX](https://www.spigotmc.org/resources/essentialsx.9089/) on our server, and we want to be able to use `/afk` and `/hat` in command blocks. This would allow us to use (for example) the following commands in command blocks:
 
@@ -67,6 +67,8 @@ commands:
 
 :::
 
+::::
+
 ## Arbitrary command conversion
 
 Some commands that are registered by plugins aren’t present in the plugin's `plugin.yml` file. Due to this, the CommandAPI can’t link a command to its respective plugin for command conversion. To deal with this, the CommandAPI can link arbitrary commands via the `other-commands-to-convert` option in the CommandAPI's `config.yml` file.

docs/en/user-setup/config.md

@@ -255,7 +255,7 @@ Controls the list of plugins to process for command conversion. See [Command con
 plugins-to-convert: []
 ```
 
-**Example values**
+**Example value**
 
 ```yml
 plugins-to-convert:

docs/en/user-setup/install.md

@@ -65,7 +65,7 @@ This can be mitigated by running a [Paper](https://papermc.io/) Minecraft server
 ```
 
 
-::: tip **Example - Running the CommandAPI using Java 17 and Minecraft 1.13.2**
+::: tip Example - Running the CommandAPI using Java 17 and Minecraft 1.13.2
 
 For example, to use the CommandAPI with Java 17 and Minecraft 1.13.2:
 

package.json

@@ -11,6 +11,7 @@
   },
   "devDependencies": {
     "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.10.0",
+    "@sindresorhus/slugify": "^2.2.1",
     "@types/markdown-it": "^14.1.2",
     "@types/markdown-it-container": "^2.0.10",
     "fs": "^0.0.1-security",