Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow escaping *see* notation #41

Open
SebastienGllmt opened this issue Jan 8, 2024 · 0 comments
Open

Allow escaping *see* notation #41

SebastienGllmt opened this issue Jan 8, 2024 · 0 comments

Comments

@SebastienGllmt
Copy link

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 facebook/docusaurus#4288 (comment))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant