Ageratum

<div align="center"> # Ageratum <img src="https://cdn.modrinth.com/data/9YApuDd3/61364fba871740b28fdbeb591c6fca7586fc129f_96.webp" style="width: 128px; height: 128px" alt="Ageratum Logo"> !(https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/built-with/java21_vector.svg) !(https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/neoforge_vector.svg) !(https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/unsupported/fabric_vector.svg) !(https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/unsupported/forge_vector.svg) (https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg)] (https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/curseforge_vector.svg)] (https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/documentation/readthedocs_vector.svg)] (https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/patreon-plural_vector.svg)] (https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg)] (https://img.shields.io/badge/License-LGPL%20v3-blue.svg)] (https://img.shields.io/badge/Asset%20License-ARR-green.svg)] : https://www.patreon.com/gugle2308 : https://spdx.org/licenses/LGPL-3.0-only.html : https://gist.github.com/Gu-ZT/38961ed5c97500cf61b04ab048fa38ad : https://modrinth.com/mod/ageratum : https://www.curseforge.com/minecraft/mc-mods/ageratum : https://ageratum.anvilcraft.dev/ : https://discord.gg/4ZsG8m9XcM </div> A guidebook mod for Minecraft NeoForge, designed to provide in-game guides for other mods. Ageratum offers rich Markdown rendering, i18n localization, and an extensible custom syntax/component system. ## (https://anvil-dev.github.io/en/posts/docs/ageratum/) ## Features ### Core Markdown Support ✅ **Block Elements** - ATX headings (`# ~ ######`) and Setext headings (underline style) - Paragraphs and line breaks - Ordered, unordered, and task lists (multi-level nesting) - Blockquotes (multi-level nesting) - Fenced code blocks (backticks and tildes) and indented code blocks - Horizontal rules - Tables with alignment settings - Images (namespace-local references) ✅ **Inline Elements** - **bold**, *italic*, ~~strikethrough~~ - Inline code spans (multi-backtick support) - (https://example.com) and autolinks - Escape character support - Custom color tags - **Hover and Click Events** (`<hover>` and `<click>` tags) ✅ **Advanced Features** - Reference link definitions and reference link syntax - Automatic link expansion - Code block line numbers - Table column alignment (left/center/right) ### Internationalization (i18n) - Documents organized by `ageratum/<language_code>/` (e.g., `en_us`, `zh_cn`) - Default fallback to `en_us` if localized version missing - Full support for multi-byte characters (Chinese, Japanese, etc.) ### Extension Syntax Two block-level extension syntaxes for custom components: #### 1. Colon Syntax ```markdown ::: info This is an info box. ::: ::: tip This is a tip. ::: ::: warning This is a warning. ::: ::: danger This is a danger warning. ::: ``` #### 2. Tag Syntax ```markdown <namespace:component key="value" param=123> Block content supports Markdown syntax. </namespace:component> <namespace:component/> Self-closing form without content. ``` Namespace can be omitted (defaults to `ageratum:`). ### Built-in Extension Components - `ageratum:info` - Blue info box - `ageratum:tip` - Green tip box - `ageratum:warning` - Orange warning box - `ageratum:danger` - Red danger box ### Hover and Click Events Support interactive text that allows players to hover for tooltips or click to perform actions. #### Hover Events (`<hover>`) Display tooltip text when hovering over text: ```markdown <hover type="SHOW_TEXT" data="This is the tooltip">Hover over me</hover> ``` **Supported Types:** - `SHOW_TEXT` - Display plain text tooltip (`data` is the tooltip content) #### Click Events (`<click>`) Execute an action when clicking on text: ```markdown <click type="OPEN_URL" data="https://example.com">Click to open link</click> <click type="COPY_TO_CLIPBOARD" data="Text to copy">Click to copy</click> <click type="SUGGEST_COMMAND" data="/say hello">Click to suggest command</click> ``` **Supported Types:** - `OPEN_URL` - Open a URL (`data` is the complete URL) - `COPY_TO_CLIPBOARD` - Copy text to clipboard (`data` is the text to copy) - `SUGGEST_COMMAND` - Suggest a command in chat (`data` is the command text) #### Combining Styles You can combine multiple styles in the same text: ```markdown <hover type="SHOW_TEXT" data="This is a tooltip"><click type="OPEN_URL" data="https://example.com">Click and hover on me!</click></hover