1. Headings
SoMarkDown supports six heading levels following CommonMark, using # symbols.
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
2. Text Styles
Basic Styles
| Effect | Syntax |
|---|
| Bold | **text** or __text__ |
| Italic | *text* or _text_ |
| ==Highlight== | ==text== |
| Superscript | text^sup^ |
| Subscript | text~sub~ |
Strikethrough | ~~text~~ |
**bold text**
*italic text*
==highlighted text==
H^2^O (superscript)
CO~2~ (subscript)
~~strikethrough~~
Underline
Wrap text with ++. Every pair of + adds one underline level — you can stack levels by adding more +:
++underlined text++
++++double underline++++
Blockquote
> Quoted text
>
> Multiple paragraphs supported
3. Special Symbols
Emoji
Uses markdown-it-emoji syntax: :emoji_name:
Copyright Symbols
| Character | Syntax |
|---|
| © | (c) or (C) |
| ® | (r) or (R) |
| ™ | (tm) or (TM) |
4. Lists
Ordered List
1. First item
2. Second item
3. Third item
Unordered List
Any of *, +, or - work as list markers:
- First item
- Second item
- Nested item
5. Table of Contents
Insert [[TOC]] anywhere in the document to generate an automatic table of contents based on headings.
Reference: markdown-it-table-of-contents
6. Code
Code highlighting is powered by highlight.js. Use highlight.js language identifiers for the language tag.
Inline Code
Use the `print()` function to output text.
Code Block
```python
def hello():
print("Hello, SoMarkDown!")
```
python, javascript, typescript, java, c, cpp, bash, sql, json. See the full list.
Math is rendered by KaTeX using standard LaTeX syntax.
Inline Math
The mass-energy equation $E = mc^2$ is a cornerstone of physics.
Euler's identity: $e^{i\pi} + 1 = 0$
Display Math
$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$
8. Images
imgDescEnabled config option:
new SoMarkDown({ imgDescEnabled: true })
9. Tables
SoMarkDown uses HTML <table> tags for tables instead of the native Markdown pipe syntax. This provides full support for merged cells (rowspan / colspan).
<table>
<thead>
<tr>
<th>Column A</th>
<th>Column B</th>
<th>Column C</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="2">Merged cell</td>
<td>B1</td>
<td>C1</td>
</tr>
<tr>
<td>B2</td>
<td>C2</td>
</tr>
</tbody>
</table>
10. Captions
Captions can annotate a Figure or Table. They start with : (colon + space).
: Figure 1 — User growth trend
- Must start with
: (a colon followed by exactly one space)
- Must be directly adjacent to the target component (above or below), with blank lines allowed but no other elements in between
- If captions exist on both sides, the one above takes priority
Reference: Pandoc caption extension
11. Chemical Equations
Chemical equations use \ce{} syntax rendered by mhchem, and must be placed inside a math environment.
Inline
The reaction $\ce{H2 + O2 -> H2O}$ is exothermic.
Display
$$
\ce{CO2 + C -> 2 CO}
$$
$$
\ce{2H2 + O2 ->[\text{ignition}] 2H2O}
$$
12. Chemical Structures (SMILES)
Chemical structures use \smiles{} syntax rendered by SmilesDrawer, and must be placed inside a math environment.
SoMarkDown treats SMILES notation as a special symbol within the math environment. This is because: (1) structures appear inside chemical equations; (2) like math formulas, they need both inline and display layout modes; (3) it keeps the integration consistent with chemical equations.
Inline Structure
Ethanol has the structure $\smiles{CCO}$.
Display Structure
Mixed Chemical Structure Equations (mhchem + SMILES)
SoMarkDown innovatively supports embedding \smiles{} inside \ce{}, merging structural and equation notation in a single expression:
$$
\ce{\smiles{CCO} + \smiles{O} -> \smiles{CC(O)O}}
$$
new SoMarkDown({
smiles: {
disableColors: false,
width: 300,
height: 200
}
})
13. Diagrams — Mermaid (Coming Soon)
Mermaid diagram support is in development. The planned syntax:
```mermaid
graph TD
A[Start] --> B{Decision}
B -->|Yes| C[Execute]
B -->|No| D[End]
```
Footnote support is planned with the following syntax:
A statement requiring citation[^1].
[^1]: Full footnote text goes here.
