ahtlon/deck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Rework Markdown checklist explanation

Browse Source
This commit is contained in:
Arno
2020-06-08 12:56:54 +02:00
parent 2b2a8f7b27
commit 70601bb8f7
1 changed files with 5 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Markdown.md
View File

@@ -16,22 +16,16 @@ That same link offers also a comprehensive list of what is supported, and what i
## Note about checklists ## Note about checklists
It is possible to create checklist in Deck by writing it in Markdown, using the following syntax: It is possible to create checklists in Deck by writing it in Markdown, using the following syntax:
```md ```md
- [ ] This is a unchecked item - [ ] This is a not checked item
- [x] This is a checked item - [x] This is a checked item
``` ```
Then, the items can be checked and unchecked by clicking on the rendered checkbox. Then, the items can be checked and unchecked by clicking on the rendered checkbox.
Also, a summary of the completed items will be visible under the card element. Also, a summary of the completed items will be visible at the bottom of the card element.
## Known Issues ## 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. 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. If you come by another case of broken link, or broken display of links, please report it by opening a new issue.