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.

Sign up for GitHub

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

Jump to bottom

Frontmatter injection for MD and MDX #4176

Merged
merged 35 commits into from
Aug 5, 2022
Merged

Frontmatter injection for MD and MDX #4176

merged 35 commits into from
Aug 5, 2022

Conversation

bholmesdev
Copy link
Contributor

Changes

  • Allow remark and rehype plugins to inject frontmatter using the vfile prop
    • Asserts all export names are valid, with meaningful error messages if not
    • Safely checks type
  • Add vfile to renderMarkdown output

Testing

Test frontmatter injection in MD and MDX

  • reading time test
  • title generator test

Docs

withastro/docs#1204

@bholmesdev
feat: inject vfile data as exports
e848e0a
@bholmesdev
feat: add vfile to renderMarkdown output
5c95301
@bholmesdev
feat: add safe astroExports parser to utils
522a9b6
@bholmesdev
refactor: expose vite-plugin-utils on astro package
90fda92
@bholmesdev
feat: handle astroExports in mdx
4f5d3ea
@bholmesdev
deps: vfile
cb5cc36
@bholmesdev
chore: lockfile
6f9b6f1
@bholmesdev
test: astroExports in mdx
4c310ca
@bholmesdev
refactor: merge plugin exports into forntmatter
155a805
@bholmesdev
refactor: astroExports -> astro.frontmatter
b387f28
@bholmesdev
refactor: md astroExports -> astro.frontmatter
e10d58d
@bholmesdev
feat: astro.frontmatter vite-plugin-markdown
9f556e6
@bholmesdev
chore: remove unused import
113a9b7
@bholmesdev
fix: inline safelyGetAstroData in MDX integration
286c9b3
@bholmesdev
chore: check that frontmatter export is valid export name
5800887
@bholmesdev
chore: error log naming
7f6a1f1
@bholmesdev
test: mdx remark frontmatter injection
12afe63
@bholmesdev
fix: inconsistent shiki mod resolution
9a7a10d
@bholmesdev
fix: add new frontmatter and heading props
ac237cf
@bholmesdev
test: remark vdata
3c7a530
@bholmesdev
fix: spread astro.data.frontmatter
5dde99f
@bholmesdev
test deps: mdast-util-to-string, reading-time
11a23a6
@bholmesdev
fix: astro-md test package name
cd18073
@bholmesdev
test: md frontmatter injection
8a823b8
@bholmesdev
fix: layouts
d2080bd
@bholmesdev
deps: remove vite-plugin-utils export
26ce328
@bholmesdev
fix: package lock
53c1871
@bholmesdev
chore: remove dup import
b8cb430
@changeset-bot
Copy link

changeset-bot bot commented Aug 5, 2022 •
edited
Loading

🦋 Changeset detected

Latest commit: cf72d48

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

This PR includes changesets to release 14 packages
Name Type
astro Minor
@astrojs/mdx Minor
@astrojs/markdown-remark Patch
@e2e/astro-component Patch
@e2e/error-react-spectrum Patch
@e2e/error-sass Patch
@e2e/errors Patch
@e2e/lit-component Patch
@e2e/preact-component Patch
@e2e/react-component Patch
@e2e/solid-component Patch
@e2e/svelte-component Patch
@e2e/e2e-tailwindcss Patch
@e2e/ts-resolution Patch

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 the pkg: astro Related to the core `astro` package (scope) label Aug 5, 2022
@github-actions github-actions bot added pkg: integration Related to any renderer integration (scope) feat: markdown Related to Markdown (scope) labels Aug 5, 2022
natemoo-re
natemoo-re reviewed Aug 5, 2022
View reviewed changes
Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really cool! Excited to have this feature. Just was curious about injected values overriding user-authored ones.

packages/integrations/mdx/src/astro-data-utils.ts Outdated Show resolved Hide resolved
@natemoo-re natemoo-re merged commit 2675b86 into main Aug 5, 2022
@natemoo-re natemoo-re deleted the feat/vfile-data-md-mdx branch August 5, 2022 23:55
@astrobot-houston astrobot-houston mentioned this pull request Aug 6, 2022
Merged
@mrienstra mrienstra mentioned this pull request Jan 30, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natemoo-re natemoo-re natemoo-re approved these changes

@FredKSchott FredKSchott Awaiting requested review from FredKSchott

Assignees
No one assigned
Labels
feat: markdown Related to Markdown (scope) pkg: astro Related to the core `astro` package (scope) pkg: integration Related to any renderer integration (scope)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bholmesdev @FredKSchott @natemoo-re