summaryrefslogtreecommitdiff
path: root/.changeset/clean-donuts-walk.md
diff options
context:
space:
mode:
Diffstat (limited to '.changeset/clean-donuts-walk.md')
-rw-r--r--.changeset/clean-donuts-walk.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/.changeset/clean-donuts-walk.md b/.changeset/clean-donuts-walk.md
new file mode 100644
index 000000000..1af111a4b
--- /dev/null
+++ b/.changeset/clean-donuts-walk.md
@@ -0,0 +1,13 @@
+---
+'@astrojs/markdown-remark': major
+'astro': major
+---
+
+Cleans up Astro-specfic metadata attached to `vfile.data` in Remark and Rehype plugins. Previously, the metadata was attached in different locations with inconsistent names. The metadata is now renamed as below:
+
+- `vfile.data.__astroHeadings` -> `vfile.data.astro.headings`
+- `vfile.data.imagePaths` -> `vfile.data.astro.imagePaths`
+
+The types of `imagePaths` has also been updated from `Set<string>` to `string[]`. The `vfile.data.astro.frontmatter` metadata is left unchanged.
+
+While we don't consider these APIs public, they can be accessed by Remark and Rehype plugins that want to re-use Astro's metadata. If you are using these APIs, make sure to access them in the new locations.