Shiroi Markdown Feature Test Document
This is a comprehensive document to test all the Markdown syntax features supported by the Shiroi blog system.
Table of Contents
- Basic Markdown Syntax
- Extended Text Formats
- Lists & Tasks
- Tables
- Mathematical Formulas (KaTeX)
- Code Blocks
- Containers & Layouts
- Rich Links
- Mentions & Social
- Alert Boxes
- Definition Lists
- Footnotes
- Multimedia
- Advanced Features
Basic Markdown Syntax
Header Levels
Level 1 Header H1
Level 2 Header H2
Level 3 Header H3
Level 4 Header H4
Level 5 Header H5
Level 6 Header H6
Text Styles
This is a regular text.
This is bold text
This is italic text
This is bold italic text
This is strikethrough text
Links & Images
This is an image
Horizontal Rule
Blockquote
This is a blockquote.
Blockquotes can contain multiple paragraphs.
— Source
Extended Text Formats
Mark (Highlight)
This is highlighted text, used for emphasis.
Inserted Text
This is newly inserted content.
Spoiler Text
||spoiler|| text.
Inline Code
Use console.log() to output debug information.
Lists & Tasks
Unordered List
- Item 1
- Item 2
- Subitem 2.1
- Subitem 2.2
- Nested Subitem 2.2.1
- Item 3
Ordered List
- Step 1
- Step 2
- Substep 2.1
- Substep 2.2
- Step 3
GFM Task List
- Task to complete
- Completed task
- Another completed task
- Task in progress
Tables
Basic Table
| Header 1 | Header 2 | Header 3 |
|---|---|---|
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
Alignment
| Left Align | Center Align | Right Align |
|---|---|---|
| Content A | Content B | Content C |
| Data 1 | Data 2 | Data 3 |
Complex Table Example
| Expression | Example | Description |
|---|---|---|
| File | options.txt | Text file |
| Variable | <version> | Placeholder |
| Must Delete | libraries *** | Asterisk marked |
Mathematical Formulas (KaTeX)
Inline Formula
This is an inline formula:
Einstein's famous equation:
Polynomial:
Block Formula
Code Blocks
JavaScript Code
TypeScript Code
Python Code
Shell Script
Mermaid Flowchart
Mermaid Sequence Diagram
Containers & Layouts
Banner Alert
Gallery Image Gallery
Image Caption
Grid Layout
Grid Item 1
This is the content of the first grid item.
Grid Item 2
This is the content of the second grid item.
Grid Item 3
This is the content of the third grid item.
Image Grid
Masonry Layout
Rich Links
Shiroi supports automatic detection and rendering of links from various platforms.
GitHub Repository
https://github.com/Innei/Shiro
GitHub Commit
https://github.com/Innei/Shiro/commit/6957e011439eb2d3cbf42bfb67ed81b07d4bcc2a
GitHub Pull Request
https://github.com/Innei/Shiro/pull/129
GitHub Gist
https://gist.github.com/Innei/94b3e8f078d29e1820813a24a3d8b04eTwitter/X
YouTube
CodeSandbox
Regular Link
Mentions & Social
GitHub User Mention
Twitter User Mention
Telegram User Mention
Auto Display Name
Alert Boxes
NOTE
This is a note, meant to inform the user of important information they need to know.
TIP
This is a tip, providing guidance to the user on how to complete the task.
IMPORTANT
This is important information, the user needs to pay special attention to this to achieve their goal.
WARNING
This is a warning, the user needs to act immediately to avoid issues.
CAUTION
This is a caution, alerting the user about risks or potential negative results of their actions.
Definition Lists
Basic Definitions
Term 1 : This is the definition for Term 1. It can span multiple lines.
Term 2 : This is the first definition for Term 2. : This is the second definition for Term 2.
Formatted Definitions
HTML : Hyper Text Markup Language : Standard markup language for creating web pages.
CSS : Cascading Style Sheets : Style sheet language for describing web page layouts.
Compact Style
Term 1 ~ Definition 1
Term 2 ~ Definition 2a ~ Definition 2b
Footnotes
This is a text with footnotes[^1]. You can place footnote references anywhere in the text[^2].
Footnotes will appear at the end of the document.
Multimedia
Video
You can directly use the <video> tag or a video link.
LinkCard Component
Advanced Features
Abbreviation
This is an example of HTML, which will be automatically marked as an abbreviation.
*Text Markup Language
Details Folding
Tabs
This is the content for the first tab.
Excalidraw Sketch
React Remote Component Rendering
Comprehensive Testing
This section combines various features for testing.
Nested Feature Test
Use highlight and spoiler text in the blockquote.
Formula:
Code: const x = 10
Complex Content in Lists
- Item 1: Contains
codeand italic- Subitem 1: highlighted text
- Subitem 2: Link Text
- Item 2: Mathematical formula
Item 3:
CodeBlock Loading...
Formatting in Tables
| Feature | Syntax | Example |
|---|---|---|
| Bold | **text** | Bold |
| Italic | *text* | Italic |
| Code | `code` | code |
| Highlight | ==text== | highlight |
| Formula | $formula$ |
Test Summary
This document covers all special Markdown syntax supported by Shiroi:
✅ Basic Syntax: Headers, paragraphs, lists, links, images, tables, blockquotes ✅ Extended Text: Highlighting (==), Insertion (++), Spoilers (||) ✅ Task Lists: GFM Tasks ✅ Mathematical Formulas: KaTeX Inline and Block ✅ Code Highlighting: Shiki supports multiple languages ✅ Containers & Layouts: Banner, Gallery, Grid, Masonry ✅ Rich Links: GitHub, Twitter, YouTube automatic recognition ✅ Social Mentions: GH, TW, TG user mentions ✅ Alert Boxes: GitHub Alerts (NOTE/TIP/WARNING etc.) ✅ Definition Lists: Term definitions ✅ Footnotes: Citation references ✅ Advanced Features: Tabs, Excalidraw, Remote Components
Last Updated: February 17, 2026 Project: Shiroi (Shiroi) Document Version: 1.0.0