Markdown Syntax Guide¶

This guide covers all the Markdown syntax supported by U.WIKI, including standard Markdown and Material theme extensions.

Basic Syntax¶

Headings¶

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Text Formatting¶

Style	Syntax	Example
Bold	`text`	bold text
Italic	`text`	italic text
Bold & Italic	`*text*`	*bold italic*
Strikethrough	`~~text~~`	~~strikethrough~~
Highlight	`==text==`	highlighted
Subscript	`H~2~O`	H₂O
Superscript	`X^2^`	X²

Lists¶

Unordered Lists¶

- Item 1
- Item 2
  - Nested item
  - Another nested item
- Item 3

Ordered Lists¶

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

Task Lists¶

- [x] Completed task
- [ ] Uncompleted task
- [ ] Another task

Completed task
Uncompleted task
Another task

Links and Images¶

Links¶

[Link text](https://example.com)
[Link with title](https://example.com "Title text")
[Reference link][ref]

[ref]: https://example.com

Images¶

![Alt text](image.png)
![Alt text](image.png "Image title")

Code¶

Inline Code¶

Use backticks for inline code: code here

Code Blocks¶

```python
def hello_world():
    print("Hello, World!")
```

def hello_world():
    print("Hello, World!")

Code with Line Numbers¶

def factorial(n):
    if n <= 1:
        return 1
    return n * factorial(n - 1)

result = factorial(5)
print(f"5! = {result}")

Tables¶

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1    | Data     | Data     |
| Row 2    | Data     | Data     |

Header 1	Header 2	Header 3
Row 1	Data	Data
Row 2	Data	Data

Admonitions¶

Note

This is a note admonition.

Tip

This is a tip admonition.

Warning

This is a warning admonition.

Danger

This is a danger admonition.

Success

This is a success admonition.

Info

This is an info admonition.

Question

This is a question admonition.

Example

This is an example admonition.

Collapsible Admonitions¶

Click to expand

This content is hidden by default.

Expanded by default

This content is visible by default but can be collapsed.

Content Tabs¶

Tab 1Tab 2Tab 3

Content for tab 1

Content for tab 2

Content for tab 3

Diagrams with Mermaid¶

graph LR
    A[Start] --> B{Decision}
    B -->|Yes| C[Do this]
    B -->|No| D[Do that]
    C --> E[End]
    D --> E

Mathematical Expressions¶

Inline math: \(x^2 + y^2 = z^2\)

Block math:

\[ \frac{n!}{k!(n-k)!} = \binom{n}{k} \]

Keyboard Keys¶

Use Ctrl+Alt+Del to restart.

Common shortcuts: - Cmd+C to copy - Cmd+V to paste - Cmd+Z to undo

Footnotes¶

Here's a sentence with a footnote¹.

Definition Lists¶

Term 1: Definition for term 1
Term 2: Definition for term 2; Another definition for term 2

Abbreviations¶

The HTML specification is maintained by the W3C.

Advanced Features¶

Icons¶

User account Alert icon Bookmark

Progress Bars¶

[=0% "Empty"] [=50% "Half full"] [=100% "Complete"]

Details¶

Click to reveal details

This content is hidden until you click the summary. You can include any Markdown content here: - Lists - Code blocks - Images - etc.

Best Practices¶

Use meaningful headings - They create the table of contents
Keep paragraphs short - Easier to read on all devices
Use code blocks - For any code or configuration
Add alt text to images - For accessibility
Use admonitions - To highlight important information
Create cross-references - Link related content

More Resources¶

This is the footnote content. ↩