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

Update Markdown type signature to match behavior #4423

Merged
merged 5 commits into from
Aug 25, 2022

Conversation

bholmesdev
Copy link
Contributor

Changes

  • Update MarkdownInstance type to match new vite-plugin-markdown output
    • Make getHeadings and compiledContent synchronous
    • Change default to AstroComponentFactory
    • Improve JS Docs across fields
  • Add file and url as top-level layout props for Markdown and MDX. This 1) makes layout props more consistent with MarkdownInstance, and 2) addresses 2 confused users in our support threads that expected top-level props

Testing

Add file and url prop tests to Markdown and MDX

Docs

TODO

@changeset-bot
Copy link

changeset-bot bot commented Aug 22, 2022

🦋 Changeset detected

Latest commit: 2ecc30a

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

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

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pkg: integration Related to any renderer integration (scope) labels Aug 22, 2022
@matthewp matthewp added the semver: minor Change triggers a `minor` release label Aug 23, 2022
@matthewp matthewp merged commit d4cd7a5 into main Aug 25, 2022
@matthewp matthewp deleted the fix/markdown-type-instance branch August 25, 2022 21:08
This was referenced Aug 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: astro Related to the core `astro` package (scope) pkg: integration Related to any renderer integration (scope) semver: minor Change triggers a `minor` release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants