Markdown Syntax

WharfDocs supports full Markdown syntax with extended features through ParsedownExtra.

#Headings

Use # symbols to create headings:

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

#Text Formatting

Bold text using **bold** or __bold__

Italic text using *italic* or _italic_

Bold and italic using ***text***

Strikethrough using ~~strikethrough~~

#Lists

#Unordered Lists

- Item 1
- Item 2
  - Nested item 2.1
  - Nested item 2.2
- Item 3

#Ordered Lists

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

Create links using [text](url):

[Visit WharfDocs](https://example.com)

Result: Visit WharfDocs

#Images

Add images using ![alt text](url):

![Documentation Screenshot](/assets/screenshot.png)

#Code

#Inline Code

Use backticks for inline code:

Use the `composer install` command

#Code Blocks

Use triple backticks with language specification:

```php
<?php
function hello() {
    echo "Hello, World!";
}
```

Result:

<?php
function hello() {
    echo "Hello, World!";
}

#Supported Languages

  • PHP
  • JavaScript
  • Python
  • Bash
  • JSON
  • HTML
  • CSS
  • And many more!

#Blockquotes

Create blockquotes using >:

> This is a blockquote.
> It can span multiple lines.

Result:

This is a blockquote. It can span multiple lines.

#Tables

Create tables using pipes and hyphens:

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

Result:

Header 1 Header 2 Header 3
Cell 1 Cell 2 Cell 3
Cell 4 Cell 5 Cell 6

#Horizontal Rules

Create horizontal rules using three or more hyphens:

---

#Task Lists

Create task lists using - [ ] and - [x]:

- [x] Completed task
- [ ] Incomplete task
- [ ] Another task

#Footnotes

Add footnotes using [^1]:

Here's a sentence with a footnote[^1].

[^1]: This is the footnote content.

#Advanced Features

#Definition Lists

Term 1
: Definition 1

Term 2
: Definition 2a
: Definition 2b

#Abbreviations

*[HTML]: Hyper Text Markup Language
*[CSS]: Cascading Style Sheets

The HTML and CSS specifications are maintained by W3C.

#Best Practices

  1. Use Semantic Headings: Start with H1 and use hierarchy properly
  2. Add Alt Text to Images: Improves accessibility
  3. Specify Code Languages: Enables proper syntax highlighting
  4. Keep Lines Short: Improves readability in source
  5. Use Relative Links: For internal documentation links