markdown-it-rust / markdown-it

markdown-it js library rewritten in rust
Other
79 stars 9 forks source link

Add Footnotes #7

Open mitsuhiko opened 1 year ago

mitsuhiko commented 1 year ago

Not sure if this is something that belongs into the core plugin selection, but the main missing feature I came across are footnotes.

digitalmoksha commented 1 year ago

+1 for footnote support as a provided plugin. It would be great to have full GFM support built-in - I'm thinking of parity with cmark-gfm. It's already pretty darn close.

digitalmoksha commented 1 year ago

I think we would just need a port of https://github.com/markdown-it/markdown-it-footnote, wouldn't have to be included in this package

digitalmoksha commented 1 year ago

@rlidwka Are there any difficulties you see, if I were to attempt to port markdown-it-footnote into Rust, or have you by chance already started that?

rlidwka commented 1 year ago

Are there any difficulties you see, if I were to attempt to port markdown-it-footnote into Rust, or have you by chance already started that?

No, I didn't start it yet. You're very welcome to submit a PR or publish it as a separate crate.

chrisjsewell commented 1 year ago

Heya, all done, plus tasklists etc 😄 https://github.com/chrisjsewell/markdown-it-plugins.rs -> https://crates.io/crates/markdown-it-footnote, ... (feedback definitely welcome!)

and also, added bonus ✨, it gave the opportunity to play around with Python bindings for Rust: https://github.com/chrisjsewell/markdown-it-pyrs

Its all released and working well although, as I was creating these, I made a big list of things to feedback here: https://github.com/chrisjsewell/markdown-it-pyrs#todo Maybe I can open some issues for these here and also, when I find more time, some PRs

rlidwka commented 1 year ago

@chrisjsewell, what are your intentions regarding those plugins?

I've noticed that it has approximately the same kind of things as in src/plugins/extras here, there's even an overlap (anchors).

May I suggest we find a way to work together on all markdown-it rust plugins?

Can move them all here (I can give you access, and make this repo into workspace). Or we can move all extra plugins (strikethrough and such) to your repository, and I only focus on pure cmark here. Or maybe create a new organization for markdown-it-rust specifically?

chrisjsewell commented 1 year ago

Heya @rlidwka, yep definitely interested to work together 👍

As you can see in https://github.com/chrisjsewell/markdown-it-plugins.rs/pull/19, I just added a (just about) fully spec compliant GFM plugin 🎉 This incorporates the anchors plugin, that is designed to allow for GitHub compliance, which the plugin in this repo does not.

My main intention was to start having the "major" CommonMark extensions supported with markdown-it.rs, and also others from https://github.com/executablebooks/mdit-py-plugins. Then also eventually look into if I could implement a https://myst-parser.readthedocs.io implementation, and even a complimentary reStructureText parser

I think making a markdown-it-rust organisation makes sense, so that this repo can be the "more stable" base implementation, and then indeed I can move my repo to the org

rlidwka commented 1 year ago

I think making a markdown-it-rust organisation makes sense, so that this repo can be the "more stable" base implementation, and then indeed I can move my repo to the org

Okay, I'll set it up sometime soon.

@chrisjsewell, do you have a Discord? Or any other place we can discuss it in realtime?

chrisjsewell commented 1 year ago

do you have a Discord? Or any other place we can discuss it in realtime?

Hmm, no specific discord, I guess feel free to get in touch via chrisj_sewell@hotmail.com

rlidwka commented 1 year ago

@chrisjsewell, I've added a organization for this, invited you as owner.

The most important question here: do you have any suggestion for organization logo?

Hmm, no specific discord, I guess feel free to get in touch

Nah I was hoping for more quick communication channel. Email is basically the same as github issues here.

You don't have any chat for user support for your python projects? Like markdown-it has gitter for this, although I haven't been following it.

chrisjsewell commented 1 year ago

do you have any suggestion for organization logo?

Oh I do 😄: https://www.figma.com/file/UQMOXPceC59IgWzvStffC2/markdown-it?type=design&node-id=0%3A1&mode=design&t=BhSWUqRf0AjDprFf-1

For markdown-it in general:

markdown-it

For markdown-it.rs

markdown-it rs

for markdown-it-py

markdown-it-py

chrisjsewell commented 1 year ago

Nah I was hoping for more quick communication channel You don't have any chat for user support for your python projects?

Not so much, normally just use github issues/discussion; rest of communication is email, slack channels, ms teams, whatsapp, ... too many these days already 😅

I just joined the markdown-it gitter if thats helpful

digitalmoksha commented 1 year ago

@chrisjsewell Nice job putting all those together! 🚀