diff --git a/docs/Markdown.md b/docs/Markdown.md index 5584b1d57..87a478a6b 100644 --- a/docs/Markdown.md +++ b/docs/Markdown.md @@ -1,6 +1,6 @@ ## What is Markdown -The [wikipedia markdown entry](https://en.wikipedia.org/wiki/Markdown) introduced markdown as : +The [wikipedia markdown entry](https://en.wikipedia.org/wiki/Markdown) introduced markdown as : > Markdown is a lightweight markup language with plain text formatting syntax. It is designed so that it can be converted to HTML and many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. As the initial description of Markdown contained ambiguities and unanswered questions, many implementations and extensions of Markdown appeared over the years to answer these issues. @@ -14,14 +14,18 @@ That same link offers also a comprehensive list of what is supported, and what i [CommonMark Markdown Reference](http://commonmark.org/help/) +## Note about checklists + +It is possible to create checklists in Deck by writing it in Markdown, using the following syntax: +```md +- [ ] This is a not checked item +- [x] This is a checked item +``` +Then, the items can be checked and unchecked by clicking on the rendered checkbox. +Also, a summary of the completed items will be visible at the bottom of the card element. + ## Known Issues -As per [issue #127](https://github.com/nextcloud/deck/issues/127) Due to a known limitation of the current script to support markdown, Links that contain the `")"` character will not display well, or will break. +As per [issue #127](https://github.com/nextcloud/deck/issues/127) Due to a known limitation of the current script to support markdown, Links that contain the `")"` character will not display well, or will break. The recommended solution is to use `"<"` and `">"` to wrap those links. It should assure their integrity. If you come by another case of broken link, or broken display of links, please report it by opening a new issue. - - - - - -