primitive-dodoc
primitive-dodoc copied to clipboard
Allow escaping *see* notation
Currently, if your contract inherits another contract, documentation is generated using a see
notation as follows
*See {IERC721-approve}.*
However, this is problematic because {}
are reserved characters in MDX2 to indicate running inline Javascript, causing a Could not parse expression with acorn
error (see here)
There are two options to fix this:
Option 1) Stop using {}
Either as a feature flag or in general, a different notation other than {}
could be used for this notation (I'm not sure if there is any reason this notation was picked in the first place)
Option 2) Add front matter for the generated files to avoid MDX
Docusaurus uses MDX by default, but as of this year it can also be forced to use standard markdown (see here). However, it does seem like right now this setting still doesn't fix our issue (as per https://github.com/facebook/docusaurus/issues/4288#issuecomment-1880406713)