Let me know what everyone thinks!
| Type | Description | Aliases |
|---|---|---|
| note | For general notes and information | - |
| abstract | For summaries or abstract sections | summary, tldr |
| info | For informational content | - |
| todo | For task lists or todo items | - |
| tip | For tips and important information | hint, important |
| success | For success messages | check, done |
| question | For questions and FAQs | help, faq |
| warning | For warnings | caution, attention |
| failure | For failure notices | fail, missing |
| danger | For danger or error messages | error |
| bug | For bug reports or known issues | - |
| example | For examples | - |
| quote | For quotes | cite |
| basketball | For basketball | - |
Syntax to use:
> [!note]
> Test
[!note]
Test
> [!todo]- My Todo List
>
> - [x] Write documentation
> - [ ] Add tests
> - [ ] Review code
[!todo]- My Todo List
- Write documentation
- Add tests
- Review code
> [!tip] **Tip**: Use `quote callouts` to enhance readability. They provide clarity and precision.
[!tip] Tip: Use
quote calloutsto enhance readability. They provide clarity and precision.
> [!question] Can callouts be nested?
>
> > [!todo] Yes!, they can.
> >
> > > [!example] You can even use multiple layers of nesting.
[!question] Can callouts be nested?
[!todo] Yes!, they can.
[!example] You can even use multiple layers of nesting.
> [!basketball]
> Great game last night!
[!basketball]
Great game last night!
