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

Add support for specifying metadata options via MDX comments #28

Open
bunchesofdonald opened this issue Sep 13, 2024 · 0 comments
Open

Comments

@bunchesofdonald
Copy link

bunchesofdonald commented Sep 13, 2024

I would like to use this project to add tests to our documentation, but we use Mintlify to render our docs. The issue is that it interprets options in the "lang" portion of the fence as a title of the code snippet. It would be great if we could add these options in an MDX comment (the only thing I've found that Mintlify won't render) above the code snippet, like:

{/* pmd-metadata: notest fixture:capsys */}
```python
print("hello")
captured = capsys.readouterr()
assert captured.out == "hello\n"
...
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