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

Document markdown myst usage #310

Closed
jacopok opened this issue Aug 22, 2022 · 4 comments · Fixed by #311
Closed

Document markdown myst usage #310

jacopok opened this issue Aug 22, 2022 · 4 comments · Fixed by #311

Comments

@jacopok
Copy link

jacopok commented Aug 22, 2022

Hello, I've tried using this extension in conjunction with myst and it works well; for example, the effect of the rst command

:cite:p:`1987:nelson`

can be equivalently obtained in a markdown file as

{cite:p}`1987:nelson`

My guess is that this generalizes; it would be nice to briefly mention it in the README, since it's a simple thing but it might leave a user confused regarding the correct syntax (it did for me).

@mcmtroffaes
Copy link
Owner

Thanks, that's a great suggestion!

@mcmtroffaes
Copy link
Owner

Could you double check this example (to be added to the docs)?

    See {cite:p}`1987:nelson` for an introduction to non-standard analysis.

    ```{bibliography} references.bib
    ``` 

@jacopok
Copy link
Author

jacopok commented Aug 22, 2022

I tried your example verbatim and it is working for me, thanks!
Renders as
image
with the furo theme.

@mcmtroffaes
Copy link
Owner

Awesome, many thanks for the quick turnaround!

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

Successfully merging a pull request may close this issue.

2 participants