📜 MiniMag & Markdown Feature Overview

This document provides an overview of the formatting syntax supported by the TranslateMiniMag function, which processes a mix of standard Markdown and a custom "MiniMag" syntax.

📝 Text Formatting

✨ Emphasis & Inline Formatting

A variety of inline styling options are available.

✍️ Headers

Standard ATX-style headers are supported from H1 to H6.

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Header 1

Header 2

Header 3

Header 4

Header 5

Header 6

↩️ Line Breaks

• A single newline is treated as a soft break (rendered as a space).

• To create a hard break (<br/>), end a line with two spaces or a backslash (`).

This is one line.
This is part of the same line.

This line ends with two spaces.  
This is a new line.

This line ends with a backslash.\
This is also a new line.

This is one line. This is part of the same line.

This line ends with two spaces.
This is a new line.

This line ends with a backslash.
This is also a new line.

🛡️ Escaping Characters

You can display literal special characters by prefixing them with a backslash `. This is useful for characters that have special meaning in Markdown.

\*This is not italic, but literal asterisks\*

🧱 Block Elements

💬 Blockquotes

Use > for blockquotes. Nesting is supported. The MiniMag ;quote command can also be used.

> This is a quote.
>
> > This is a nested quote.

This is a quote.

This is a nested quote.

;quote Author
This is a quote using the MiniMag command.
;end

Author

This is a quote using the MiniMag command.

📋 Lists

Both ordered and unordered lists are supported, including nesting.

Unordered Lists

Use *, -, or +. Indent with two spaces for nested lists.

* Item 1
* Item 2
  - Nested Item 2.1
  - Nested Item 2.2

• Item 1

• Item 2

  • Nested Item 2.1

  • Nested Item 2.2

Ordered Lists

Use a number followed by a period.

1. First item
2. Second item
   1. Nested item
3. Third item

1. First item

2. Second item

   1. Nested item

3. Third item

💻 Code Blocks

Fenced Code Blocks

Use triple backticks (```) or (~~~) to create a fenced code block. The content inside is not formatted.

```
function hello() {
  // This is a code block
  return "Hello, World!";
}
```

function hello() {
  // This is a code block
  return "Hello, World!";
}

MiniMag Code Blocks

The ;begin and ;end commands create a literal block, similar to a fenced code block.

;begin
This is a literal block.
No formatting is applied here.
;end

This is a literal block.
No formatting is applied here.

📏 Horizontal Rule

Create a horizontal rule with three or more hyphens, asterisks, or underscores on a line by themselves. The MiniMag command ;--- also works.

---
***
___

🤫 Spoilers (MiniMag)

Use the ;spoiler command to create a collapsible spoiler block.

;spoiler Click to see more
This content is hidden by default.
;end

🔗 Links & Images

Standard Links & Images

Standard Markdown syntax for links and images is fully supported, including optional titles.

[Fresh IDE](https://fresh.flatassembler.net "Visit the website")
![AsmBB Logo](https://asmbb.org/!attached/22 "AsmBB")

Fresh IDE

🔗 MiniMag Links

MiniMag uses a two-part system for reusable reference-style links and also supports special prefixed links for images, videos, and anchors.

this is [?https://github.githubassets.com/assets/1f44d-41cb66fe1e22.png]      ; Inline image
this is  [!https://github.githubassets.com/assets/1f680-d0ef47fdb515.png]      ; Block image

this is Inline image

this is Block image

📊 Tables

Pipe Tables

The translator supports standard Markdown pipe tables. Note that alignment syntax (:---:) is parsed but not currently implemented for alignment.

| Header 1 | Header 2 |
|---|---|
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |

MiniMag Tables

The ;table and ;--- commands can be used to create tables.

;table
# Header 1
# Header 2
;---
Row 1, Cell 1 | Row 1, Cell 2
;---
Row 2, Cell 1 | Row 2, Cell 2
;end

😄 Emojis

The parser automatically detects and renders standard emoji Unicode sequences.

Here is a test: 💻 😄 🚀

💻 😄 🚀

📜 MiniMag Commands

MiniMag extends Markdown with special commands that begin with a semicolon at the start of a line.