--- tags: '@badging/documentation' --- # What the Markdown! ## Triage ![](https://i.imgur.com/LRanGMg.jpg) ## Topics - Indents ## References ### Markdown - https://en.wikipedia.org/wiki/Markdown - https://daringfireball.net/projects/markdown/syntax `must read` - https://spec.commonmark.org/ - https://github.github.com/gfm/ ### HTML - https://html.spec.whatwg.org/multipage/ - https://www.w3.org/TR/html53/ - https://en.wikipedia.org/wiki/HTML5 ## Examples ### Aastha - https://hackmd.io/@7f7uN_UHRtOhM5rnON3_HQ/Hke4pog1v ### @smotaal/mdon - https://github.com/polyestr/mdon - https://www.npmjs.com/package/mdon - https://classic.yarnpkg.com/en/package/mdon #### Broken images when using relative paths to SVG (compared to PNG) - https://github.com/what-the-fragment/packages-with-readme-relative-images/issues/1 - https://github.com/yarnpkg/website/issues/692 - https://github.com/npm/marky-markdown/issues/420 #### HTML Comments end up showing in package.html's readme section - https://github.com/yarnpkg/website/issues/685 <!-- - https://github.com/search?p=2&q=author%3Asmotaal+yarn+is%3Aissue&type=Issues - https://github.com/Haroenv/packages-with-readme-relative-images