Remark and rehype plugins #562

akellbl4 · 2021-06-27T17:26:35Z

Resolves #239

Changes

adds the ability to configure remark plugins
adds the ability to configure rehype plugins
adds example with remark plugins

Testing

add tests

Docs

add docs

changeset-bot · 2021-06-27T17:26:37Z

🦋 Changeset detected

Latest commit: c25ecff

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
astro	Minor
@astrojs/markdown-support	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2021-06-27T17:26:39Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/pikapkg/astro-www/J2EDW3U51QRnE2CQKNQQwf5trs4x
✅ Preview: https://astro-www-git-fork-akellbl4-add-hook-for-remark-plugins-pikapkg.vercel.app

packages/markdown-support/src/types.ts

packages/markdown-support/src/index.ts

natemoo-re

Overall looks great! A few suggestions, but I think this is really close. Thanks for jumping right on this!

Could you add a .astro page that uses import { Markdown } from 'astro/components' to the example here?

natemoo-re · 2021-06-28T13:35:12Z

cc @matthewp if you could take a look at how the remark/rehype plugins are loaded that would be awesome. I feel like this might need to use the configManager you introduced?

akellbl4 · 2021-06-28T16:09:23Z

@natemoo-re thank you for the review, I wanted to make sure if I'm on the right way

examples/with-remark-plugins/astro.config.mjs

packages/markdown-support/src/index.ts

matthewp · 2021-06-28T19:08:19Z

I left some comments.

matthewp

lgtm, will defer to @natemoo-re on any changes he thinks are important.

natemoo-re

This looks great!

Do you want to work on integrating these changes with import { Markdown } from 'astro/components'; in a .astro file or would you be more comfortable if I did that?

akellbl4 · 2021-06-29T16:32:48Z

@natemoo-re I would love to help with that.

Should I add docs for the feature?
I'm not really sure how I can add tests for it.

natemoo-re · 2021-06-29T16:40:04Z

@akellbl4 Awesome! Why don't you add some docs to this branch and I will add tests? I'm thinking about splitting <Markdown> support into another branch.

natemoo-re · 2021-06-30T18:18:32Z

@akellbl4 looks amazing—thank you SO much for all your work on this!

I'm going to take care of the tests tomorrow and then this should be good to merge.

akellbl4 · 2021-07-01T07:26:34Z

@natemoo-re thank you for your help! It's pleasure to work on the project.
I have a few requests that already exist, for example, this one #397, but it's blocked by another issue. I would love to help with it or whatever blocks it.

- connect plugins by name - make plugins configurable - connect gfm and footnotes if no plugins provided from config - add more plugins to example

natemoo-re · 2021-07-01T16:51:50Z

@akellbl4 Docs look great and I added some tests to make sure there aren't regressions.

Thanks again for getting this over the line, folks will be really excited about this feature!

wooorm · 2021-07-01T17:00:44Z

Awesome stuff!

* remark plugins * remove unused dependency * enable codeblocks * backward compatibility with remark-code-titles * add support for rehype plugins * add proper types for plugins * fixes after review - connect plugins by name - make plugins configurable - connect gfm and footnotes if no plugins provided from config - add more plugins to example * update and rename example * add documentation for markdown plugins * chore: rename with-markdown-plugins example * chore: restructure dependencies * feat: add back smartypants, fix mdx expressions * chore: remove log * test: add markdown plugin tests * chore: add changeset * docs: update markdown doc Co-authored-by: Nate Moore <nate@skypack.dev>

vercel bot deployed to Preview June 27, 2021 17:26 View deployment

vercel bot deployed to Preview June 27, 2021 17:46 View deployment

vercel bot deployed to Preview June 27, 2021 20:18 View deployment

vercel bot deployed to Preview June 28, 2021 07:40 View deployment

vercel bot deployed to Preview June 28, 2021 07:43 View deployment

akellbl4 changed the title ~~Remark plugins~~ Remark and rehype plugins Jun 28, 2021

vercel bot deployed to Preview June 28, 2021 07:48 View deployment

akellbl4 marked this pull request as ready for review June 28, 2021 07:50

natemoo-re reviewed Jun 28, 2021

View reviewed changes

packages/markdown-support/src/types.ts Outdated Show resolved Hide resolved

natemoo-re reviewed Jun 28, 2021

View reviewed changes

packages/markdown-support/src/types.ts Show resolved Hide resolved

natemoo-re reviewed Jun 28, 2021

View reviewed changes

packages/markdown-support/src/index.ts Outdated Show resolved Hide resolved

natemoo-re requested changes Jun 28, 2021

View reviewed changes

matthewp reviewed Jun 28, 2021

View reviewed changes

examples/with-remark-plugins/astro.config.mjs Outdated Show resolved Hide resolved

matthewp reviewed Jun 28, 2021

View reviewed changes

packages/markdown-support/src/index.ts Outdated Show resolved Hide resolved

matthewp reviewed Jun 28, 2021

View reviewed changes

packages/markdown-support/src/index.ts Outdated Show resolved Hide resolved

vercel bot deployed to Preview June 28, 2021 22:01 View deployment

akellbl4 requested review from natemoo-re and matthewp June 28, 2021 22:02

matthewp approved these changes Jun 29, 2021

View reviewed changes

natemoo-re reviewed Jun 29, 2021

View reviewed changes

natemoo-re approved these changes Jun 29, 2021

View reviewed changes

natemoo-re force-pushed the add-hook-for-remark-plugins branch from 3ff818d to c03a295 Compare June 29, 2021 16:41

vercel bot deployed to Preview June 29, 2021 16:41 View deployment

vercel bot deployed to Preview June 30, 2021 11:49 View deployment

akellbl4 force-pushed the add-hook-for-remark-plugins branch from d16a64a to 5851675 Compare June 30, 2021 12:35

vercel bot deployed to Preview June 30, 2021 12:35 View deployment

akellbl4 force-pushed the add-hook-for-remark-plugins branch from 5851675 to 14c1fd9 Compare June 30, 2021 12:40

vercel bot deployed to Preview June 30, 2021 12:40 View deployment

vercel bot deployed to Preview July 1, 2021 16:39 View deployment

Pavel Mineev and others added 16 commits July 1, 2021 12:49

remark plugins

bfdbdd9

remove unused dependency

21a5007

enable codeblocks

91b1f7d

backward compatibility with remark-code-titles

c4dbecb

add support for rehype plugins

e9ed65c

add proper types for plugins

5e2b158

fixes after review

9b7ce57

- connect plugins by name - make plugins configurable - connect gfm and footnotes if no plugins provided from config - add more plugins to example

update and rename example

101a3e8

add documentation for markdown plugins

aa50348

chore: rename with-markdown-plugins example

dcad39b

chore: restructure dependencies

13b77b8

feat: add back smartypants, fix mdx expressions

c2314a3

chore: remove log

c727779

test: add markdown plugin tests

43d4e8f

chore: add changeset

575e7fc

docs: update markdown doc

c25ecff

natemoo-re force-pushed the add-hook-for-remark-plugins branch from 9f75910 to c25ecff Compare July 1, 2021 16:50

vercel bot deployed to Preview July 1, 2021 16:50 View deployment

natemoo-re merged commit d396943 into withastro:main Jul 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remark and rehype plugins #562

Remark and rehype plugins #562

akellbl4 commented Jun 27, 2021 •

edited

Loading

changeset-bot bot commented Jun 27, 2021 •

edited

Loading

vercel bot commented Jun 27, 2021 •

edited

Loading

natemoo-re left a comment

natemoo-re commented Jun 28, 2021

akellbl4 commented Jun 28, 2021

matthewp commented Jun 28, 2021

matthewp left a comment

natemoo-re left a comment

akellbl4 commented Jun 29, 2021 •

edited

Loading

natemoo-re commented Jun 29, 2021

natemoo-re commented Jun 30, 2021

akellbl4 commented Jul 1, 2021

natemoo-re commented Jul 1, 2021

wooorm commented Jul 1, 2021

Remark and rehype plugins #562

Remark and rehype plugins #562

Conversation

akellbl4 commented Jun 27, 2021 • edited Loading

Changes

Testing

Docs

changeset-bot bot commented Jun 27, 2021 • edited Loading

🦋 Changeset detected

vercel bot commented Jun 27, 2021 • edited Loading

natemoo-re left a comment

Choose a reason for hiding this comment

natemoo-re commented Jun 28, 2021

akellbl4 commented Jun 28, 2021

matthewp commented Jun 28, 2021

matthewp left a comment

Choose a reason for hiding this comment

natemoo-re left a comment

Choose a reason for hiding this comment

akellbl4 commented Jun 29, 2021 • edited Loading

natemoo-re commented Jun 29, 2021

natemoo-re commented Jun 30, 2021

akellbl4 commented Jul 1, 2021

natemoo-re commented Jul 1, 2021

wooorm commented Jul 1, 2021

akellbl4 commented Jun 27, 2021 •

edited

Loading

changeset-bot bot commented Jun 27, 2021 •

edited

Loading

vercel bot commented Jun 27, 2021 •

edited

Loading

akellbl4 commented Jun 29, 2021 •

edited

Loading