search

executablebooks / markdown-it-docutils

A markdown-it plugin for implementing docutils style roles/directives.
https://executablebooks.github.io/markdown-it-docutils/
MIT License
12 stars 9 forks source link

What is the status of this project? #48

Open tavin opened 1 year ago

tavin commented 1 year ago

Hi folks, just wondering, if this is being retired in favor of markdown-it-myst should this be noted on the front page?

Perhaps more importantly, if markdown-it-myst is used instead of this, what's the rendering solution? I can't figure out if there's another package that provides rendering, or if markdown-it-docutils is still the answer for now, or else what I'm supposed to do in my project.

Thank you.

welcome[bot] commented 1 year 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:

rowanc1 commented 1 year ago

Thanks @tavin -- I left a bit of an answer here: https://github.com/executablebooks/mystjs/issues/181

I think that this package is still the (easiest) answer for the use case you are looking for (rendering myst and rendering with markdown-it). The packages in the mystjs repo are not direct replacements for the markdown-it rendering path at this time.

tavin commented 1 year ago

Thanks @rowanc1 good to know.

I wanted to add myst support in tiddlywiki as wished by @sneakers-the-rat in https://github.com/orgs/executablebooks/discussions/978.

Right now it looks like markdown-it-docutils is the only realistic way. But obviously it's falling behind the mystjs implementation. One can live without sphinx proof (if there's a way to simulate it with custom admonitions), however things like this and this are still broken.

I wonder if I can get your buy-in on continuing to accept maintenance patches in this project? Also I think it's hard, given a web-first use case, to accept a roadblock on certain features because sphinx would ignore them in a pdf build.

The alternative is I think to really archive this project and close the markdown-it-myst gap.