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

Use new markdown-it plugins #8

Closed
chrisjsewell opened this issue Sep 15, 2021 · 12 comments
Closed

Use new markdown-it plugins #8

chrisjsewell opened this issue Sep 15, 2021 · 12 comments
Labels
enhancement New feature or request

Comments

@chrisjsewell
Copy link

Essentially, this plugin should eventually mirror: https://github.com/executablebooks/myst-vs-code/blob/master/src/extension.ts

A few things to consider here:

  1. We want configuration to enable MyST syntax extensions; this should be easy to achieve here
  2. the VS extension allows loading the CSS provided by markdown-it-docutils: https://github.com/executablebooks/myst-vs-code/blob/c8c96542171ebe6ccdd896cf8337a5ffffeb73d4/package.json#L115. Can we achieve that here

cc @agoose77

@welcome
Copy link

welcome bot commented Sep 15, 2021

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

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! 🎉

@chrisjsewell chrisjsewell added the enhancement New feature or request label Sep 15, 2021
@chrisjsewell
Copy link
Author

and yeh, as I've just mention on a jupyter thread, you can check out some of the plugin rendering at:

@chrisjsewell
Copy link
Author

Also to note, there is still activity going on around these plugins: executablebooks/meta#449

@rowanc1
Copy link
Member

rowanc1 commented Sep 16, 2021

Once some more of those are merged in we can merge jupyter-book/mystmd#33 and then this package can consume the updates with a version bump. I think it is worth combining and having a myst-specific export (which this package is meant for).

I am planning on getting back to the PRs that you reviewed last week today or tomorrow.

@chrisjsewell
Copy link
Author

Yep indeed 👍 just wanted to make @agoose77 of the changes, and start thinking about the config/css points

@agoose77
Copy link
Collaborator

Appreciate it all, I'm following this remotely!

@agoose77
Copy link
Collaborator

So, it seems to me that we have the following top-level plugins that we need to expose/require as jupyterlab-markup plugins:

  • markdown-it-front-matter
  • markdown-it-footnote*
  • markdown-it-docutils
  • markdown-it-dollarmath
  • markdown-it-amsmath
  • markdown-it-deflist*
  • markdown-it-task-lists*

* already provided by jupyterlab-markup

@chrisjsewell
Copy link
Author

chrisjsewell commented Jan 19, 2022

Yep, plus there are some "small" plugins currently directly implemented in https://github.com/executablebooks/myst-vs-code/blob/master/src/mdPlugins.ts

@agoose77
Copy link
Collaborator

Could we move that inline plugin into a new / existing package(s)?

@chrisjsewell
Copy link
Author

most certainly, this is where I was thinking markdown-it-myst might come in useful

@agoose77
Copy link
Collaborator

Ah OK. I'm not 100% confident with the entire MyST landscape yet, so I'm not clear on where everything goes. In my head, I envisage markdown-it-myst being an empty meta-package that just depends upon the building blocks of a MyST Markdown variant. In that case, it would perhaps be ideal if this small mdPlugins belonged to the "another" markdown-it-myst-extras package?

@chrisjsewell
Copy link
Author

it would perhaps be ideal if this small mdPlugins belonged to the "another" markdown-it-myst-extras package?

Ask and you shall receive 😉
https://github.com/executablebooks/markdown-it-myst-extras

rowanc1 added a commit that referenced this issue Feb 10, 2023
Uses the `--jp-content-link-color` with a fallback.

See #8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants