executablebooks / rst-to-myst

Convert ReStructuredText to MyST Markdown
https://rst-to-myst.readthedocs.io
MIT License
59 stars 10 forks source link

Feedback #5

Closed chrisjsewell closed 3 years ago

chrisjsewell commented 3 years ago

@choldgraf @mmcky @AakashGfude

As mentioned on Slack, this is in part a replacement for https://github.com/executablebooks/sphinx-tomyst. The key difference/improvement is that it directly uses and adapts the docutils/rst parsing code to produce a lossless AST, notably not actually running directives or roles; so you don't have to reverse engineer what they were. You also don't need to run the whole sphinx process (or need a conf.py); just point it at a file/piece of RST and it will convert it.

Additionally, it has some other tricks up its sleeve, such as being able to list all available roles/directives and showing the options for a particular one.

The documentation is all in the README, so yeh give it a go and report back: if you have any good exemplar RST files to try against it (and maybe add to the tests), or if any other feature requirements come to mind?

welcome[bot] commented 3 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada: