From 44d49b57b90730e0eb65b7be5ef31dec42b1f7ae Mon Sep 17 00:00:00 2001 From: Mehrad Mahmoudian Date: Mon, 27 Jul 2020 20:19:11 +0300 Subject: [PATCH] fixed a typo and added checked checkbox in Markdown Guide (#3556) * Doc: Fixed a typo in a markdown syntax of a link * Doc: added an example of a checked checkbox and added how the checkboxes would get translated when turned to HTML * Doc: added a picture of a rendered markdown checkbox in Joplin --- docs/images/Markdown_checkbox.jpg | Bin 0 -> 2592 bytes readme/markdown.md | 8 ++++++-- 2 files changed, 6 insertions(+), 2 deletions(-) create mode 100644 docs/images/Markdown_checkbox.jpg diff --git a/docs/images/Markdown_checkbox.jpg b/docs/images/Markdown_checkbox.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9bd7fbc31ca9ad5c7fa3f142b4a9e688c0302812 GIT binary patch literal 2592 zcmbW0cU03^7RP^SKnNfSN$ADUt4b9NNLkQ`$O3{42vQX$B1LH$q(nhMiingbz4w-Y zQl-P7QiJpoa43QT3L*?LVP?fU`HT0xlr7kTu3eif*Z??*;n zd{{Ie3XMS@9s+_e_dsEA7z~c)L~x@2XC1r(kZgc6K!bpA02m2^AVCN1fGD$080ZfH ze-jAItdWJ44bF~WE}(G(U=RcXhC&XjX08rm<^d=YhB|sekA=s~krn5SRt|lf$tJE} z*@7`2SeH<7@(F{pV|n@b1tg`UWn|@4)zmdkYHAt$#n9-?S;9GsiCq zXIFR6FM~tF^pSU?W8-s-`GxntE-o#vY;1o1vbFtn=iBZf7YKm-iN&1%1p6m0B$Epa zg+idLhg=}AKhqE-6n69k3rf$7)zO;=ryRVdu6K#M*P=y;J@d414;^R>AsJV#@B|B_DQlFAY^`8~Dh$=}-Gk?EO=k47J~Aw} zUZI31dAJ6`Cf5pVUc|s5HS|>e7#1&Zq2_iuvA}$gZB*Gnpkm1qP*Vd)GaGrWv%lGn z_OxdNAU3n(R)`>?a{|(=p`F;~ABAQz~k! z-5kWnB70>HfHL|QXSeMm!HS=MvZbw7Al#MCpK}S&lQ6R7mqVNw59k%O37=`RF{CU< zu{?DJFS|KcASbe-4CO0ItVP8pHs`#%gk>NLSUI? zXLtI2@MIW!9vN$n5JLqf_T;IaC~lC3e0|?3DILe*KxzycoN2i$N)11m(NFDmiWyi% zidRQlDn1We4`D@C0triJ`7sUwHwmcacuu8mLT;fk>z>xtfpe=k@z^*F$m_*?Oads| z5dBxs4~-$05R7#4YY?1oaDsS(9ewhpauHWYtbrL|0hJksHH^PU^HcH<`;OfJ6 zH{WF0K86(+9rcHYN^J`!RJ}hdyzaxLtrWs8Poa}c3iTKk*~@hoc?T7!sifX{ivU0Yfxk_5)vvCwZ>l zUyRJ8AdDy0l>EbZYZ|J!bSWB-!(NstzAQck}`|^~RHsaUM2qub{PTiAVkMIal2pIyUV906K08$(*vUH3S0dr`>k_G8x6D+_w8! zA3v@VI9QYirwra_L_2-oW^-(r-LCI6-|XRGML(8g)o*gl(b7?Uf0BcTUy6P_f0 zejd|AA8@mmq|XkN(~j^jk6*cut2x!sy%kJt74K5o#G64EV-5ftU`3|HM59YbaKtf? zdH`^{`wvJqPly;3M;9!~3Qg{EUGN0&`aH|<0M#kpt~7xSaih9352&S5#)T~m)XZA0M3fHj3R2CvDekBSQ7X&11s)UMrKDmmtynzbl;+(_cCTCFY& zZT9aSSRM6rAVj>RUggbe^a4mzGc~k@+}1^OIs^=H12&lee*qbQI}g z<2n_*XZ*}yK)NBZRe4~#l|p`&6zkR=wU8|w%y>nQ{xh%`ymn$9gEdgV5bRBMk$ZaC{s z+jRDq5c$kkjp+OeH=omE*-0uj>m$wTFMUf^rg0<{9 literal 0 HcmV?d00001 diff --git a/readme/markdown.md b/readme/markdown.md index 7e52ae66a..4053506a5 100644 --- a/readme/markdown.md +++ b/readme/markdown.md @@ -121,9 +121,13 @@ Note that Mermaid graphs are always rendered on a white background regardless of Checkboxes can be added like so: - [ ] Milk - - [ ] Rice + - [x] Rice - [ ] Eggs +Which would turn into: + +![Checkbox support in Joplin](https://joplin.cozic.net/images/Markdown_checkbox.jpg) + The checkboxes can then be ticked in the mobile and desktop applications. ### HTML support @@ -150,7 +154,7 @@ Note that the functionality added by these plugins is not part of the CommonMark | [Sup](https://github.com/markdown-it/markdown-it-sup) | `X^2^` | Transforms into X2 | no | [View](https://joplinapp.org/images/md_plugins/sup_plugin.jpg) | | [Deflist](https://github.com/markdown-it/markdown-it-deflist) | See [pandoc](http://johnmacfarlane.net/pandoc/README.html#definition-lists) page for syntax | Adds the html `
` tag accessible through markdown | no | [View](https://joplinapp.org/images/md_plugins/deflist_plugin.jpg) | | [Abbr](https://github.com/markdown-it/markdown-it-abbr) | *[HTML]: Hyper Text Markup Language
The HTML specification | Allows definition of abbreviations that can be hovered over later for a full expansion | no | [View](https://joplinapp.org/images/md_plugins/abbr_plugin.jpg) | -| [Emoji](https://github.com/markdown-it/markdown-it-emoji) | `:smile:` | Transforms into 😄. See [this list](https://gist.github.com/rxaviers/7360908) for more emojis | no |!View[]https://joplinapp.org/images/md_plugins/emoji_plugin.jpg) | +| [Emoji](https://github.com/markdown-it/markdown-it-emoji) | `:smile:` | Transforms into 😄. See [this list](https://gist.github.com/rxaviers/7360908) for more emojis | no |[View](https://joplinapp.org/images/md_plugins/emoji_plugin.jpg) | | [Insert](https://github.com/markdown-it/markdown-it-ins) | `++inserted++` | Transforms into `inserted` (inserted) | no | [View](https://joplinapp.org/images/md_plugins/insert_plugin.jpg) | | [Multitable](https://github.com/RedBug312/markdown-it-multimd-table) | See [MultiMarkdown](https://fletcher.github.io/MultiMarkdown-6/syntax/tables.html) page | Adds more power and customization to markdown tables | no | [View](https://joplinapp.org/images/md_plugins/multitable_plugin.jpg) | | [Fountain](https://fountain.io) | \`\`\`fountain
Your screenplay...
\`\`\` | Adds support for the Fountain markup language, a plain text markup language for screenwriting | no | [View](https://joplinapp.org/images/md_plugins/fountain_plugin.jpg) |