Skip to content

Commit

Permalink
Document markdown limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
srid committed Apr 9, 2020
1 parent 6ef5392 commit 409a5a0
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions guide/2011404.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Zettel files are written using the [Markdown](https://en.wikipedia.org/wiki/Mark
* [2011505](z://metadata)
* [2013702](z://synhigh)
* [2013701](z://mathjax)
* [2014401](z://limit)
10 changes: 10 additions & 0 deletions guide/2014401.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Markdown Limitations
---

Zettel Markdown format is limited in a few ways owing to the strict parsing nature of `mmark`, the parser library used by neuron.

Notably, URI references must respect RFC 3986. Quotting [mmark's README](https://github.com/mmark-md/mmark#mmark-and-common-mark):

> All URI references (in links, images, autolinks, etc.) are parsed as per RFC 3986, no support for escaping or support for entity and numeric character references is provided. In addition to that, when a URI reference in not enclosed with `<` and `>`, then closing parenthesis character `)` is not considered part of URI (use `<uri>` syntax if you want a closing parenthesis as part of a URI).

0 comments on commit 409a5a0

Please sign in to comment.