Skip to content
This repository has been archived by the owner on Oct 14, 2023. It is now read-only.

Evaluate MyST (reST-like Markdown flavor) for docs #977

Closed
astrojuanlu opened this issue Jun 15, 2020 · 4 comments
Closed

Evaluate MyST (reST-like Markdown flavor) for docs #977

astrojuanlu opened this issue Jun 15, 2020 · 4 comments

Comments

@astrojuanlu
Copy link
Member

https://twitter.com/choldgraf/status/1272633413132943360

https://myst-parser.readthedocs.io/en/latest/index.html

I've been observing the development of MyST over the past few months and I think it's very promising. A real alternative to ditch reST (a markdown language used only in the Python community) while keep most of its interesting features and fixing some of most obvious reST shortcomings.

I posed a question to Chris about docstrings and the NumPy standard, but in any case I think this is worth trying.

@astrojuanlu
Copy link
Member Author

astrojuanlu commented Jun 15, 2020

@jorgepiloto
Copy link
Member

People from executablebooks also offer converter from *.rst file into *.md ones in their project rst2myst. Might be interesting!

@astrojuanlu
Copy link
Member Author

Worth checking too executablebooks/MyST-Parser#156

@astrojuanlu
Copy link
Member Author

Closed in #1073 🎉

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

No branches or pull requests

2 participants