wekan/docs/Features/Markdown/Markdown.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

UPDATE: Wekan now uses markdown-it and markdown-it-emoji plugin, see [Emoji page](Emoji)
## Numbered text
If in List titles you like to create numbered text like this:
```
3. Something
```
Write it this way (to escape dot), so it shows correctly:
```
3\. Something
```
***
Wekan uses GFM (Github Flavored Markdown).
We use the following project that ports GFM to meteor: https://github.com/wekan/markdown with updated newest markdown, that is fork of https://github.com/perak/markdown.
Newest Wekan uses newest markdown.
[Adding markdown to more places at Wekan progress](https://github.com/wekan/wekan/issues/2334)
[Related formatting tips for numbered lists](https://github.com/wekan/wekan/issues/2425)
**Note**: In order to use gfm checklist and other v0.28+ features, you need Wekan v2.61+.
[Checklist on markdown does not work yet](https://github.com/wekan/wekan/issues/2419)
## List of guides (from web archive):
* [Guide](https://guides.github.com/features/mastering-markdown/).
* [List of features](https://github.github.com/gfm/).
## Where can I use the markdown?
* Card name.
* Board name - Works on board view only.
* Card description, list and task list.