-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Remove references to the <Markdown> component #1045
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
The more I think about the removal of the section As soon as the translated pages that were previously referring to this component have been updated by the translators, we can then remove the section entirely in a second step (in a separate PR). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love this fix and the green CI!
One note: we’ve just added an RC section in the migration guide, so we should probably also include a short note there saying something like
### `<Markdown />` Component Removed
If you were previously using Astro’s built-in `<Markdown />` component, this has been moved to a separate package. You will now need to install `@astrojs/markdown` and update your imports accordingly. For more details, see [the `@astrojs/markdown` README](...readme-link).
@matthewp I just updated the branch , so now this branch should have the latest migration guide with the RC changes section Chris is talking about. There are already some items in there, so something like @delucis 's suggestion can be added to match the style and then... did we decide this is good to go now?? (LGTM re: proofreading) |
Updated with the suggested Migration note. |
src/pages/en/migrate.md
Outdated
@@ -42,6 +42,10 @@ Astro no longer supports components or JSX expressions in Markdown pages by defa | |||
|
|||
To make migrating easier, a new [legacy flag](/en/reference/configuration-reference/#legacyastroflavoredmarkdown) can be used to re-enable previous Markdown features. | |||
|
|||
### `<Markdown />` Component Removed | |||
|
|||
If you were previously using Astro’s built-in `<Markdown />` component, this has been moved to a separate package. You will now need to install `@astrojs/markdown` and update your imports accordingly. For more details, see [the `@astrojs/markdown` README](https://github.com/withastro/astro/tree/main/packages/markdown/component). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @matthewp !
@delucis , I'm assuming that this @astrojs/markdown
component does NOT get automatically added to our Integrations page?
-
Do we want a legacy package on our integrations page, so that we don't need to send people externally to the README but can instead have a page in Docs? Or, do we specifically NOT want this showing up in Docs, because we don't want people using it unless they really have to?
-
Do we want to take this opportunity here in the migration guide to encourage people to transition to MDX, or simply say, "Here's where the new package is?"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we don't want people using it unless they really have to.
Agree that it's a good opportunity to push people towards MDX, I'll add that.
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
What kind of changes does this PR include?
Description