# Doc helper
docsify extends Markdown syntax to make your documents more readable.
> Note: For the special code syntax cases, it's better to put them within code backticks to avoid any conflict from configurations or emojis.
## Callouts
Docsify supports [GitHub style](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) callouts (also known as "admonitions" or "alerts").
> [!CAUTION]
> **Caution** callouts communicate negative potential consequences of an action.
> [!IMPORTANT]
> **Important** callouts communicate information necessary for users to succeed.
> [!NOTE]
> **Note** callouts communicate information that users should take into account.
> [!TIP]
> **Tip** callouts communicate optional information to help a user be more successful.
> [!WARNING]
> **Warning** callouts communicate potential risks user should be aware of.
**Markdown**
```markdown
> [!CAUTION]
> **Caution** callouts communicate negative potential consequences of an action.
> [!IMPORTANT]
> **Important** callouts communicate information necessary for users to succeed.
> [!NOTE]
> **Note** callouts communicate information that users should take into account.
> [!TIP]
> **Tip** callouts communicate optional information to help a user be more successful.
> [!WARNING]
> **Warning** callouts communicate potential risks user should be aware of.
```
### Legacy Style ⚠️
The following Docsify v4 callout syntax has been deprecated and will be removed in a future version.
!> Legacy **Important** callouts are deprecated.
?> Legacy **Tip** callouts are deprecated.
**Markdown**
```markdown
!> Legacy **Important** callouts are deprecated.
?> Legacy **Tip** callouts are deprecated.
```
## Link attributes
### disabled
```markdown
[link](/demo ':disabled')
```
### href
Sometimes we will use some other relative path for the link, and we have to tell docsify that we don't need to compile this link. For example:
```markdown
[link](/demo/)
```
It will be compiled to `link` and will load `/demo/README.md`. Maybe you want to jump to `/demo/index.html`.
Now you can do that
```markdown
[link](/demo/ ':ignore')
```
You will get `link`html. Do not worry, you can still set the title for the link.
```markdown
[link](/demo/ ':ignore title')
link
```
### target
```markdown
[link](/demo ':target=_blank')
[link](/demo2 ':target=_self')
```
## Task lists
```markdown
- [ ] foo
- bar
- [x] baz
- [] bam <~ not working
- [ ] bim
- [ ] lim
```
- [ ] foo
- bar
- [x] baz
- [] bam <~ not working
- [ ] bim
- [ ] lim
## Images
### Class names
```markdown
```
### IDs
```markdown
```
### Sizes
```markdown
```
## Heading IDs
```markdown
### Hello, world! :id=hello-world
```
## Markdown + HTML
You need to insert a space between the html and markdown content.
This is useful for rendering markdown content in the details element.
```markdown
Self-assessment (Click to expand)
- Abc
- Abc
```
Self-assessment (Click to expand)
- Abc
- Abc
Markdown content can also be wrapped in html tags.
```markdown
- listitem
- listitem
- listitem
```
- listitem
- listitem
- listitem