Skip to content

CHANGELOG.md

Latest commit

 

History

History
1792 lines (1085 loc) · 117 KB

CHANGELOG.md

File metadata and controls

1792 lines (1085 loc) · 117 KB
Raw

@astrojs/markdown-remark

7.3.1

Patch Changes

  • #17896 a548223 Thanks @matthewp! - Fixes <script>/<style> rendering in MDX so that only literal content (including content injected by remark/rehype plugins) is treated as trusted markup. A dynamic value passed as a <script>/<style> child (e.g. <script>{value}</script>) is now escaped like any other element's content instead of being rendered raw. Use set:html to explicitly opt a dynamic value back into raw rendering.

7.3.0

Minor Changes

  • #17262 f8e9458 Thanks @Princesseuh! - Adds MDX rendering to the unified() and satteri() processors.

    Both processors now compile .mdx files themselves. You still need to install @astrojs/mdx to add MDX support to your project.

  • #17262 f8e9458 Thanks @Princesseuh! - Adds a recmaPlugins option to unified() for adding recma (estree/JSX) plugins to the MDX compiler.

Patch Changes

  • Updated dependencies [f8e9458]:
    • @astrojs/internal-helpers@0.11.0

7.2.4

Patch Changes

  • Updated dependencies [05763a0]:
    • @astrojs/internal-helpers@0.10.4

7.2.3

Patch Changes

  • Updated dependencies [8c193f6]:
    • @astrojs/internal-helpers@0.10.3

7.2.2

Patch Changes

  • Updated dependencies [c895b12]:
    • @astrojs/internal-helpers@0.10.2

7.2.1

Patch Changes

  • Updated dependencies [eb6f97e]:
    • @astrojs/internal-helpers@0.10.1

7.2.0

Minor Changes

  • #16848 f732f3c Thanks @Princesseuh! - Adds a new markdown.processor configuration option, allowing you to choose an alternative Markdown processor.

    Websites with many Markdown/MDX files tend to be slow to build because the unified ecosystem (e.g., remark, rehype) is slow to process. This feature introduces the ability to replace this part of the build pipeline with another processor.

    The default processor is unified(). This means that existing configurations remain unchanged and your remark/rehype plugins continue to work.

    // astro.config.mjs
import { defineConfig } from 'astro/config';
import { unified } from '@astrojs/markdown-remark';
import remarkToc from 'remark-toc';

export default defineConfig({
  markdown: {
    processor: unified({
      remarkPlugins: [remarkToc],
    }),
  },
});

    In addition to this new configuration option, Astro provides a new alternative processor based on Rust: Sätteri. You can choose to use it now by installing @astrojs/markdown-satteri, importing the satteri() processor, and adapting your existing configuration:

    // astro.config.mjs
import { defineConfig } from 'astro/config';
import { satteri } from '@astrojs/markdown-satteri';

export default defineConfig({
  markdown: {
    processor: satteri({
      features: { directive: true },
    }),
  },
});

    This processor does not support the remark and rehype plugins. This means you may need to convert them to MDAST or HAST plugins to retain your current functionality.

    The existing top-level markdown.remarkPlugins, markdown.rehypePlugins, markdown.remarkRehype, markdown.gfm, and markdown.smartypants options still work, but are now deprecated and will be removed in a future major update. The matching remarkPlugins, rehypePlugins, and remarkRehype options on the MDX integration are also deprecated for the same reason. To anticipate their removal, move them onto unified({...}) (or your preferred plugin processor) :

    // astro.config.mjs
import { defineConfig } from 'astro/config';
import remarkToc from 'remark-toc';
import rehypeSlug from 'rehype-slug';
+ import { unified } from '@astrojs/markdown-remark';

export default defineConfig({
  markdown: {
+    processor: unified({
+      remarkPlugins: [remarkToc],
+      rehypePlugins: [rehypeSlug],
+      remarkRehype: true,
+      gfm: true,
+      smartypants: true,
+    }),
-    remarkPlugins: [remarkToc],
-    rehypePlugins: [rehypeSlug],
-    remarkRehype: true,
-    gfm: true,
-    smartypants: true,
  },
});

    For more information on enabling and using this feature in your project, see our Markdown guide. To give feedback on this new Rust processor, see the Native Markdown / MDX parsing and processing RFC.

Patch Changes

  • Updated dependencies [f732f3c]:
    • @astrojs/internal-helpers@0.10.0

7.1.2

Patch Changes

  • #15723 9256345 Thanks @rururux! - Updates internal type usage from @astrojs/prism.

  • Updated dependencies [d365c97, 9256345]:

    • @astrojs/internal-helpers@0.9.1
    • @astrojs/prism@4.0.2

7.1.1

Patch Changes

  • #16419 f3485c3 Thanks @matthewp! - Hardens nested object and package metadata lookups to ignore prototype keys in content handling and project scaffolding

  • Updated dependencies [99464ed, f3485c3]:

    • @astrojs/internal-helpers@0.9.0

7.1.0

Minor Changes

  • #15340 10a1a5a Thanks @trueberryless! - Updates createMarkdownProcessor to support advanced SmartyPants options.

    The smartypants property in AstroMarkdownOptions now accepts Smartypants options, allowing fine-grained control over typography transformations (backticks, dashes, ellipses, and quotes).

    import { createMarkdownProcessor } from '@astrojs/markdown-remark';

const processor = await createMarkdownProcessor({
  smartypants: {
    backticks: 'all',
    dashes: 'oldschool',
    ellipses: 'unspaced',
    openingQuotes: { double: '«', single: '‹' },
    closingQuotes: { double: '»', single: '›' },
    quotes: false,
  },
});

    For the up-to-date supported properties, check out the retext-smartypants options.

7.0.1

Patch Changes

  • Updated dependencies [d3c7de9]:
    • @astrojs/prism@4.0.1

7.0.0

Major Changes

Minor Changes

  • #15277 cb99214 Thanks @ematipico! - Fixes an issue where the function createShikiHighlighter would always create a new Shiki highlighter instance. Now the function returns a cached version of the highlighter based on the Shiki options. This should improve the performance for sites that heavily rely on Shiki and code in their pages.

  • #15332 7c55f80 Thanks @matthewp! - Exposes the fileURL option in MarkdownProcessorRenderOptions, allowing callers to specify the file URL for resolving relative image paths.

Patch Changes

7.0.0-beta.11

Patch Changes

  • Updated dependencies [4ebc1e3, 4e7f3e8]:
    • @astrojs/internal-helpers@0.8.0-beta.3

7.0.0-beta.10

Patch Changes

  • Updated dependencies [745e632]:
    • @astrojs/internal-helpers@0.8.0-beta.2

7.0.0-beta.9

Major Changes

Patch Changes

7.0.0-beta.8

Patch Changes

  • #15676 1fa4177 Thanks @rururux! - Fixes an issue where the use of the Code component would result in an unexpected error.

7.0.0-beta.7

Major Changes

7.0.0-beta.6

Patch Changes

  • Updated dependencies [a164c77, a18d727]:
    • @astrojs/internal-helpers@0.8.0-beta.1

7.0.0-beta.5

Patch Changes

  • #15297 80f0225 Thanks @rururux! - Fixes a case where code blocks generated by prism would include the is:raw attribute in the final output

7.0.0-beta.4

Patch Changes

  • Updated dependencies [240c317]:
    • @astrojs/internal-helpers@0.8.0-beta.0

7.0.0-beta.3

Minor Changes

  • #15332 7c55f80 Thanks @matthewp! - Exposes the fileURL option in MarkdownProcessorRenderOptions, allowing callers to specify the file URL for resolving relative image paths.

7.0.0-beta.2

Minor Changes

  • #15277 cb99214 Thanks @ematipico! - Fixes an issue where the function createShikiHighlighter would always create a new Shiki highlighter instance. Now the function returns a cached version of the highlighter based on the Shiki options. This should improve the performance for sites that heavily rely on Shiki and code in their pages.

Patch Changes

  • Updated dependencies [11efb05]:
    • @astrojs/prism@4.0.0-beta.2

7.0.0-beta.1

Patch Changes

7.0.0-alpha.0

Major Changes

Patch Changes

  • Updated dependencies [e131261]:
    • @astrojs/prism@4.0.0-alpha.0

6.3.10

Patch Changes

6.3.9

Patch Changes

  • Updated dependencies [9e9c528, 0f75f6b]:
    • @astrojs/internal-helpers@0.7.5

6.3.8

Patch Changes

  • Updated dependencies [b8ca69b]:
    • @astrojs/internal-helpers@0.7.4

6.3.7

Patch Changes

  • Updated dependencies [1e2499e]:
    • @astrojs/internal-helpers@0.7.3

6.3.6

Patch Changes

  • Updated dependencies [4d16de7]:
    • @astrojs/internal-helpers@0.7.2

6.3.5

Patch Changes

  • Updated dependencies [0567fb7]:
    • @astrojs/internal-helpers@0.7.1

6.3.4

Patch Changes

  • Updated dependencies [f4e8889]:
    • @astrojs/internal-helpers@0.7.0

6.3.3

Patch Changes

  • #13941 6bd5f75 Thanks @aditsachde! - Adds support for TOML files to Astro's built-in glob() and file() content loaders.

    In Astro 5.2, Astro added support for using TOML frontmatter in Markdown files instead of YAML. However, if you wanted to use TOML files as local content collection entries themselves, you needed to write your own loader.

    Astro 5.12 now directly supports loading data from TOML files in content collections in both the glob() and the file() loaders.

    If you had added your own TOML content parser for the file() loader, you can now remove it as this functionality is now included:

    // src/content.config.ts
import { defineCollection } from "astro:content";
import { file } from "astro/loaders";
- import { parse as parseToml } from "toml";
const dogs = defineCollection({
-  loader: file("src/data/dogs.toml", { parser: (text) => parseToml(text) }),
+ loader: file("src/data/dogs.toml")
  schema: /* ... */
})

    Note that TOML does not support top-level arrays. Instead, the file() loader considers each top-level table to be an independent entry. The table header is populated in the id field of the entry object.

    See Astro's content collections guide for more information on using the built-in content loaders.

6.3.2

Patch Changes

  • Updated dependencies [3c3b492]:
    • @astrojs/prism@3.3.0

6.3.1

Patch Changes

6.3.0

Minor Changes

  • #13352 cb886dc Thanks @delucis! - Adds support for a new experimental.headingIdCompat flag

    By default, Astro removes a trailing - from the end of IDs it generates for headings ending with special characters. This differs from the behavior of common Markdown processors.

    You can now disable this behavior with a new configuration flag:

    // astro.config.mjs
import { defineConfig } from 'astro/config';

export default defineConfig({
  experimental: {
    headingIdCompat: true,
  },
});

    This can be useful when heading IDs and anchor links need to behave consistently across your site and other platforms such as GitHub and npm.

    If you are using the rehypeHeadingIds plugin directly, you can also pass this new option:

    // astro.config.mjs
import { defineConfig } from 'astro/config';
import { rehypeHeadingIds } from '@astrojs/markdown-remark';
import { otherPluginThatReliesOnHeadingIDs } from 'some/plugin/source';

export default defineConfig({
  markdown: {
    rehypePlugins: [
      [rehypeHeadingIds, { experimentalHeadingIdCompat: true }],
      otherPluginThatReliesOnHeadingIDs,
    ],
  },
});

  • #13311 a3327ff Thanks @chrisirhc! - Adds a new configuration option for Markdown syntax highlighting excludeLangs

    This option provides better support for diagramming tools that rely on Markdown code blocks, such as Mermaid.js and D2 by allowing you to exclude specific languages from Astro's default syntax highlighting.

    This option allows you to avoid rendering conflicts with tools that depend on the code not being highlighted without forcing you to disable syntax highlighting for other code blocks.

    The following example configuration will exclude highlighting for mermaid and math code blocks:

    import { defineConfig } from 'astro/config';

export default defineConfig({
  markdown: {
    syntaxHighlight: {
      type: 'shiki',
      excludeLangs: ['mermaid', 'math'],
    },
  },
});

    Read more about this new option in the Markdown syntax highlighting configuration docs.

6.2.1

Patch Changes

  • Updated dependencies [042d1de]:
    • @astrojs/internal-helpers@0.6.1

6.2.0

Minor Changes

  • #13254 1e11f5e Thanks @p0lyw0lf! - Adds remote image optimization in Markdown

    Previously, an internal remark plugin only looked for images in ![]() syntax that referred to a relative file path. This meant that only local images stored in src/ were passed through to an internal rehype plugin that would transform them for later processing by Astro's image service.

    Now, the plugins recognize and transform both local and remote images using this syntax. Only authorized remote images specified in your config are transformed; remote images from other sources will not be processed.

    While not configurable at this time, this process outputs two separate metadata fields (localImagePaths and remoteImagePaths) which allow for the possibility of controlling the behavior of each type of image separately in the future.

Patch Changes

  • Updated dependencies [1e11f5e]:
    • @astrojs/internal-helpers@0.6.0

6.1.0

Minor Changes

  • #12850 db252e0 Thanks @colinbate! - Adds support for TOML frontmatter in .md and .mdx files

    Astro 5.2 automatically identifies the format of your Markdown and MDX frontmatter based on the delimiter used. With +++ as a delimiter (instead of the --- YAML code fence), your frontmatter will automatically be recognized and parsed as TOML.

    This is useful for adding existing content files with TOML frontmatter to your project from another framework such as Hugo.

    TOML frontmatter can also be used with content collections, and files with different frontmatter languages can live together in the same project.

    No configuration is required to use TOML frontmatter in your content files. Your delimiter will indicate your chosen frontmatter language:

    +++
date = 2025-01-30
title = 'Use TOML frontmatter in Astro!'
[author]
name = 'Colin Bate'
+++

# Support for TOML frontmatter is here!

6.0.2

Patch Changes

6.0.1

Patch Changes

  • #12646 f13417b Thanks @bluwy! - Avoids parsing frontmatter that are not at the top of a file

  • #12570 87231b1 Thanks @GrimLink! - Removes trailing new line in code blocks to prevent generating a trailing empty <span /> tag

  • #12664 a71e9b9 Thanks @bluwy! - Fixes frontmatter parsing if file is encoded in UTF8 with BOM

6.0.0

Major Changes

  • #11861 3ab3b4e Thanks @bluwy! - Cleans up Astro-specific 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.

  • #12008 5608338 Thanks @Princesseuh! - Welcome to the Astro 5 beta! This release has no changes from the latest alpha of this package, but it does bring us one step closer to the final, stable release.

    Starting from this release, no breaking changes will be introduced unless absolutely necessary.

    To learn how to upgrade, check out the Astro v5.0 upgrade guide in our beta docs site.

  • #11825 560ef15 Thanks @bluwy! - Updates return object of createShikiHighlighter as codeToHast and codeToHtml to allow generating either the hast or html string directly

  • #11661 83a2a64 Thanks @bluwy! - Renames the following CSS variables theme color token names to better align with the Shiki v1 defaults:

    • --astro-code-color-text => --astro-code-foreground
    • --astro-code-color-background => --astro-code-background

    You can perform a global find and replace in your project to migrate to the new token names.

  • #11861 3ab3b4e Thanks @bluwy! - Removes InvalidAstroDataError, safelyGetAstroData, and setVfileFrontmatter APIs in favour of isFrontmatterValid

Patch Changes

6.0.0-beta.3

Patch Changes

  • Updated dependencies [827093e]:
    • @astrojs/prism@3.2.0-beta.0

6.0.0-beta.2

Patch Changes

6.0.0-beta.1

Major Changes

  • #12008 5608338 Thanks @Princesseuh! - Welcome to the Astro 5 beta! This release has no changes from the latest alpha of this package, but it does bring us one step closer to the final, stable release.

    Starting from this release, no breaking changes will be introduced unless absolutely necessary.

    To learn how to upgrade, check out the Astro v5.0 upgrade guide in our beta docs site.

6.0.0-alpha.1

Major Changes

  • #11861 3ab3b4e Thanks @bluwy! - Cleans up Astro-specific 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.

  • #11825 560ef15 Thanks @bluwy! - Updates return object of createShikiHighlighter as codeToHast and codeToHtml to allow generating either the hast or html string directly

  • #11861 3ab3b4e Thanks @bluwy! - Removes InvalidAstroDataError, safelyGetAstroData, and setVfileFrontmatter APIs in favour of isFrontmatterValid

6.0.0-alpha.0

Major Changes

  • #11661 83a2a64 Thanks @bluwy! - Renames the following CSS variables theme color token names to better align with the Shiki v1 defaults:

    • --astro-code-color-text => --astro-code-foreground
    • --astro-code-color-background => --astro-code-background

    You can perform a global find and replace in your project to migrate to the new token names.

5.3.0

Minor Changes

  • #12039 710a1a1 Thanks @ematipico! - Adds a markdown.shikiConfig.langAlias option that allows aliasing a non-supported code language to a known language. This is useful when the language of your code samples is not a built-in Shiki language, but you want your Markdown source to contain an accurate language while also displaying syntax highlighting.

    The following example configures Shiki to highlight cjs code blocks using the javascript syntax highlighter:

    import { defineConfig } from 'astro/config';

export default defineConfig({
  markdown: {
    shikiConfig: {
      langAlias: {
        cjs: 'javascript',
      },
    },
  },
});

    Then in your Markdown, you can use the alias as the language for a code block for syntax highlighting:

    ```cjs
'use strict';

function commonJs() {
  return 'I am a commonjs file';
}
```

5.2.0

Minor Changes

  • #11341 49b5145 Thanks @madcampos! - Adds support for Shiki's defaultColor option.

    This option allows you to override the values of a theme's inline style, adding only CSS variables to give you more flexibility in applying multiple color themes.

    Configure defaultColor: false in your Shiki config to apply throughout your site, or pass to Astro's built-in <Code> component to style an individual code block.

    import { defineConfig } from 'astro/config';
export default defineConfig({
  markdown: {
    shikiConfig: {
      themes: {
        light: 'github-light',
        dark: 'github-dark',
      },
      defaultColor: false,
    },
  },
});
    ---
import { Code } from 'astro:components';
---

<Code code={`const useMyColors = true`} lang="js" defaultColor={false} />

5.1.1

Patch Changes

  • #11310 b6afe6a Thanks @bluwy! - Handles encoded image paths in internal rehype plugins and return decoded paths from markdown vfile's data.imagePaths

5.1.0

Minor Changes

  • #10538 ccafa8d230f65c9302421a0ce0a0adc5824bfd55 Thanks @604qgc! - Adds a data-language attribute on the rendered pre elements to expose the highlighted syntax language.

    For example, the following Markdown code block will expose data-language="python":

    \```python
def func():
    print('Hello Astro!')
\```

    This allows retrieving the language in a rehype plugin from node.properties.dataLanguage by accessing the <pre> element using { tagName: "pre" }:

    // myRehypePre.js
import { visit } from "unist-util-visit";
export default function myRehypePre() {
  return (tree) => {
    visit(tree, { tagName: "pre" }, (node) => {
      const lang = node.properties.dataLanguage;
      [...]
    });
  };
}

    Note: The <pre> element is not exposed when using Astro's <Code /> component which outputs flattened HTML.

    The data-language attribute may also be used in css rules:

    pre::before {
  content: attr(data-language);
}

pre[data-language='javascript'] {
  font-size: 2rem;
}

Patch Changes

5.0.0

Major Changes

4.3.2

Patch Changes

4.3.1

Patch Changes

4.3.0

Minor Changes

4.2.1

Patch Changes

4.2.0

Minor Changes

Patch Changes

4.1.0

Minor Changes

4.0.1

Patch Changes

  • #9349 270c6cc27 Thanks @lilnasy! - Fixes an issue where this package could not be installed alongside Astro 4.0.

4.0.0

Major Changes

  • #9138 abf601233 Thanks @bluwy! - Updates the unified, remark, and rehype dependencies to latest. Make sure to update your custom remark and rehype plugins as well to be compatible with the latest versions.

    Potentially breaking change: The default value of markdown.remarkRehype.footnoteBackLabel is changed from "Back to content" to "Back to reference 1". See the mdast-util-to-hast commit for more information.

  • #9182 c7953645e Thanks @bluwy! - Removes deprecated APIs. All Astro packages had been refactored to not use these APIs.

Patch Changes

4.0.0-beta.0

Major Changes

  • #9138 abf601233 Thanks @bluwy! - Updates the unified, remark, and rehype dependencies to latest. Make sure to update your custom remark and rehype plugins as well to be compatible with the latest versions.

    Potentially breaking change: The default value of markdown.remarkRehype.footnoteBackLabel is changed from "Back to content" to "Back to reference 1". See the mdast-util-to-hast commit for more information.

  • #9182 c7953645e Thanks @bluwy! - Removes deprecated APIs. All Astro packages had been refactored to not use these APIs.

Patch Changes

3.5.0

Minor Changes

  • #9083 4537ecf0d Thanks @bluwy! - Exports createShikiHighlighter for low-level syntax highlighting usage

3.4.0

Minor Changes

  • #8903 c5010aad3 Thanks @horo-fox! - Adds experimental support for multiple shiki themes with the new markdown.shikiConfig.experimentalThemes option.

3.3.0

Minor Changes

  • #8502 c4270e476 Thanks @bluwy! - Updates the internal shiki syntax highlighter to shikiji, an ESM-focused alternative that simplifies bundling and maintenance.

    There are no new options and no changes to how you author code blocks and syntax highlighting.

    Potentially breaking change: While this refactor should be transparent for most projects, the transition to shikiji now produces a smaller HTML markup by attaching a fallback color style to the pre or code element, instead of to the line span directly. For example:

    Before:

    <code class="astro-code" style="background-color: #24292e">
  <pre>
    <span class="line" style="color: #e1e4e8">my code</span>
  </pre>
</code>

    After:

    <code class="astro-code" style="background-color: #24292e; color: #e1e4e8">
  <pre>
    <span class="line">my code<span>
  </pre>
</code>

    This does not affect the colors as the span will inherit the color from the parent, but if you're relying on a specific HTML markup, please check your site carefully after upgrading to verify the styles.

Patch Changes

3.2.1

Patch Changes

3.2.0

Minor Changes

  • #8475 d93987824 Thanks @webpro! - feat(markdown): Add support for imageReference paths when collecting images

  • #8532 7522bb491 Thanks @bluwy! - Export createMarkdownProcessor and deprecate renderMarkdown API

Patch Changes

3.1.0

Minor Changes

Patch Changes

3.0.0

Major Changes

  • #8179 6011d52d3 Thanks @matthewp! - Astro 3.0 Release Candidate

  • #8169 e79e3779d Thanks @bluwy! - Remove pre-shiki v0.14 theme names for compatibility. Please rename to the new theme names to migrate:

    • material-darker -> material-theme-darker
    • material-default -> material-theme
    • material-lighter -> material-theme-lighter
    • material-ocean -> material-theme-ocean
    • material-palenight -> material-theme-palenight

Patch Changes

3.0.0-rc.1

Major Changes

  • #8179 6011d52d3 Thanks @matthewp! - Astro 3.0 Release Candidate

  • #8169 e79e3779d Thanks @bluwy! - Remove pre-shiki v0.14 theme names for compatibility. Please rename to the new theme names to migrate:

    • material-darker -> material-theme-darker
    • material-default -> material-theme
    • material-lighter -> material-theme-lighter
    • material-ocean -> material-theme-ocean
    • material-palenight -> material-theme-palenight

Patch Changes

3.0.0-beta.0

Patch Changes

2.2.1

Patch Changes

2.2.0

Minor Changes

  • #6932 49514e4ce Thanks @bluwy! - Upgrade shiki to v0.14.1. This updates the shiki theme colors and adds the theme name to the pre tag, e.g. <pre class="astro-code github-dark">.

Patch Changes

2.1.4

Patch Changes

2.1.3

Patch Changes

2.1.2

Patch Changes

2.1.1

Patch Changes

2.1.0

Minor Changes

  • #6344 694918a56 Thanks @Princesseuh! - Add a new experimental flag (experimental.assets) to enable our new core Assets story.

    This unlocks a few features:

    • A new built-in image component and JavaScript API to transform and optimize images.
    • Relative images with automatic optimization in Markdown.
    • Support for validating assets using content collections.
    • and more!

    See Assets (Experimental) on our docs site for more information on how to use this feature!

  • #6213 afbbc4d5b Thanks @Princesseuh! - Updated compilation settings to disable downlevelling for Node 14

Patch Changes

2.0.1

Patch Changes

2.0.0

Major Changes

  • #5687 e2019be6f Thanks @bholmesdev! - Give remark and rehype plugins access to user frontmatter via frontmatter injection. This means data.astro.frontmatter is now the complete Markdown or MDX document's frontmatter, rather than an empty object.

    This allows plugin authors to modify existing frontmatter, or compute new properties based on other properties. For example, say you want to compute a full image URL based on an imageSrc slug in your document frontmatter:

    export function remarkInjectSocialImagePlugin() {
  return function (tree, file) {
    const { frontmatter } = file.data.astro;
    frontmatter.socialImageSrc = new URL(frontmatter.imageSrc, 'https://my-blog.com/').pathname;
  };
}

    When using Content Collections, you can access this modified frontmatter using the remarkPluginFrontmatter property returned when rendering an entry.

    Migration instructions

    Plugin authors should now check for user frontmatter when applying defaults.

    For example, say a remark plugin wants to apply a default title if none is present. Add a conditional to check if the property is present, and update if none exists:

    export function remarkInjectTitlePlugin() {
  return function (tree, file) {
    const { frontmatter } = file.data.astro;
+    if (!frontmatter.title) {
      frontmatter.title = 'Default title';
+    }
  }
}

    This differs from previous behavior, where a Markdown file's frontmatter would always override frontmatter injected via remark or rehype.

  • #5785 16107b6a1 Thanks @delucis! - Drop support for legacy Astro-flavored Markdown

  • #5684 a9c292026 & #5769 93e633922 Thanks @bholmesdev! - Refine Markdown and MDX configuration options for ease-of-use.

    • Markdown

      • Replace the extendDefaultPlugins option with a gfm boolean and a smartypants boolean. These are enabled by default, and can be disabled to remove GitHub-Flavored Markdown and SmartyPants.

      • Ensure GitHub-Flavored Markdown and SmartyPants are applied whether or not custom remarkPlugins or rehypePlugins are configured. If you want to apply custom plugins and remove Astro's default plugins, manually set gfm: false and smartypants: false in your config.

    • Migrate extendDefaultPlugins to gfm and smartypants

      You may have disabled Astro's built-in plugins (GitHub-Flavored Markdown and Smartypants) with the extendDefaultPlugins option. This has now been split into 2 flags to disable each plugin individually:

      • markdown.gfm to disable GitHub-Flavored Markdown
      • markdown.smartypants to disable SmartyPants
      // astro.config.mjs
import { defineConfig } from 'astro/config';

export default defineConfig({
  markdown: {
-   extendDefaultPlugins: false,
+   smartypants: false,
+   gfm: false,
  }
});

      Additionally, applying remark and rehype plugins no longer disables gfm and smartypants. You will need to opt-out manually by setting gfm and smartypants to false.

    • MDX

      • Support all Markdown configuration options (except drafts) from your MDX integration config. This includes syntaxHighlighting and shikiConfig options to further customize the MDX renderer.

      • Simplify extendPlugins to an extendMarkdownConfig option. MDX options will default to their equivalent in your Markdown config. By setting extendMarkdownConfig to false, you can "eject" to set your own syntax highlighting, plugins, and more.

    • Migrate MDX's extendPlugins to extendMarkdownConfig

      You may have used the extendPlugins option to manage plugin defaults in MDX. This has been replaced by 3 flags:

      • extendMarkdownConfig (true by default) to toggle Markdown config inheritance. This replaces the extendPlugins: 'markdown' option.
      • gfm (true by default) and smartypants (true by default) to toggle GitHub-Flavored Markdown and SmartyPants in MDX. This replaces the extendPlugins: 'defaults' option.

  • #5825 52209ca2a Thanks @bholmesdev! - Baseline the experimental contentCollections flag. You're free to remove this from your astro config!

    import { defineConfig } from 'astro/config';

export default defineConfig({
- experimental: { contentCollections: true }
})

  • #5806 7572f7402 Thanks @matthewp! - Make astro a peerDependency of integrations

    This marks astro as a peerDependency of several packages that are already getting major version bumps. This is so we can more properly track the dependency between them and what version of Astro they are being used with.

Patch Changes

2.0.0-beta.2

See changes in 2.0.0-beta.2

Major Changes

  • #5785 16107b6a1 Thanks @delucis! - Drop support for legacy Astro-flavored Markdown

  • #5825 52209ca2a Thanks @bholmesdev! - Baseline the experimental contentCollections flag. You're free to remove this from your astro config!

    import { defineConfig } from 'astro/config';

export default defineConfig({
- experimental: { contentCollections: true }
})

  • #5806 7572f7402 Thanks @matthewp! - Make astro a peerDependency of integrations

    This marks astro as a peerDependency of several packages that are already getting major version bumps. This is so we can more properly track the dependency between them and what version of Astro they are being used with.

Patch Changes

2.0.0-beta.1

See changes in 2.0.0-beta.1

Minor Changes

  • #5769 93e633922 Thanks @bholmesdev! - Introduce a smartypants flag to opt-out of Astro's default SmartyPants plugin.

    {
  markdown: {
    smartypants: false,
  }
}

    Migration

    You may have disabled Astro's built-in plugins (GitHub-Flavored Markdown and Smartypants) with the extendDefaultPlugins option. This has now been split into 2 flags to disable each plugin individually:

    • markdown.gfm to disable GitHub-Flavored Markdown
    • markdown.smartypants to disable SmartyPants
    // astro.config.mjs
import { defineConfig } from 'astro/config';

export default defineConfig({
  markdown: {
-   extendDefaultPlugins: false,
+   smartypants: false,
+   gfm: false,
  }
});

2.0.0-beta.0

See changes in 2.0.0-beta.0

Major Changes

  • #5687 e2019be6f Thanks @bholmesdev! - Give remark and rehype plugins access to user frontmatter via frontmatter injection. This means data.astro.frontmatter is now the complete Markdown or MDX document's frontmatter, rather than an empty object.

    This allows plugin authors to modify existing frontmatter, or compute new properties based on other properties. For example, say you want to compute a full image URL based on an imageSrc slug in your document frontmatter:

    export function remarkInjectSocialImagePlugin() {
  return function (tree, file) {
    const { frontmatter } = file.data.astro;
    frontmatter.socialImageSrc = new URL(frontmatter.imageSrc, 'https://my-blog.com/').pathname;
  };
}

    Content Collections - new remarkPluginFrontmatter property

    We have changed inject frontmatter to modify frontmatter in our docs to improve discoverability. This is based on support forum feedback, where "injection" is rarely the term used.

    To reflect this, the injectedFrontmatter property has been renamed to remarkPluginFrontmatter. This should clarify this plugin is still separate from the data export Content Collections expose today.

    Migration instructions

    Plugin authors should now check for user frontmatter when applying defaults.

    For example, say a remark plugin wants to apply a default title if none is present. Add a conditional to check if the property is present, and update if none exists:

    export function remarkInjectTitlePlugin() {
  return function (tree, file) {
    const { frontmatter } = file.data.astro;
+    if (!frontmatter.title) {
      frontmatter.title = 'Default title';
+    }
  }
}

    This differs from previous behavior, where a Markdown file's frontmatter would always override frontmatter injected via remark or rehype.

  • #5684 a9c292026 Thanks @bholmesdev! - Refine Markdown and MDX configuration options for ease-of-use.

    Markdown

    • Remove remark-smartypants from Astro's default Markdown plugins.
    • Replace the extendDefaultPlugins option with a simplified gfm boolean. This is enabled by default, and can be disabled to remove GitHub-Flavored Markdown.
    • Ensure GitHub-Flavored Markdown is applied whether or not custom remarkPlugins or rehypePlugins are configured. If you want to apply custom plugins and remove GFM, manually set gfm: false in your config.

    MDX

    • Support all Markdown configuration options (except drafts) from your MDX integration config. This includes syntaxHighlighting and shikiConfig options to further customize the MDX renderer.
    • Simplify extendDefaults to an extendMarkdownConfig option. MDX options will default to their equivalent in your Markdown config. By setting extendMarkdownConfig to false, you can "eject" to set your own syntax highlighting, plugins, and more.

    Migration

    To preserve your existing Markdown and MDX setup, you may need some configuration changes:

    Smartypants manual installation

    Smartypants has been removed from Astro's default setup. If you rely on this plugin, install remark-smartypants and apply to your astro.config.*:

    // astro.config.mjs
import { defineConfig } from 'astro/config';
+ import smartypants from 'remark-smartypants';

export default defineConfig({
  markdown: {
+   remarkPlugins: [smartypants],
  }
});
    Migrate extendDefaultPlugins to gfm

    You may have disabled Astro's built-in plugins (GitHub-Flavored Markdown and Smartypants) with the extendDefaultPlugins option. Since Smartypants has been removed, this has been renamed to gfm.

    // astro.config.mjs
import { defineConfig } from 'astro/config';

export default defineConfig({
  markdown: {
-   extendDefaultPlugins: false,
+   gfm: false,
  }
});

    Additionally, applying remark and rehype plugins no longer disables gfm. You will need to opt-out manually by setting gfm to false.

    Migrate MDX's extendPlugins to extendMarkdownConfig

    You may have used the extendPlugins option to manage plugin defaults in MDX. This has been replaced by 2 flags:

    • extendMarkdownConfig (true by default) to toggle Markdown config inheritance. This replaces the extendPlugins: 'markdown' option.
    • gfm (true by default) to toggle GitHub-Flavored Markdown in MDX. This replaces the extendPlugins: 'defaults' option.

1.2.0

Minor Changes

  • #5654 2c65b433b Thanks @delucis! - Refactor and export rehypeHeadingIds plugin

    The rehypeHeadingIds plugin injects IDs for all headings in a Markdown document and can now also handle MDX inputs if needed. You can import and use this plugin if you need heading IDs to be injected before other rehype plugins run.

Patch Changes

1.1.3

Patch Changes

1.1.2

Patch Changes

1.1.1

Patch Changes

1.1.0

Minor Changes

1.1.0-next.0

Minor Changes

1.0.0

Major Changes

Patch Changes

  • Updated dependencies [04ad44563]:
    • @astrojs/prism@1.0.0

0.14.1

Patch Changes

0.14.0

Minor Changes

  • #4114 64432bcb8 Thanks @Princesseuh! - Refactor @astrojs/mdx and @astrojs/markdown-remark to use @astrojs/prism instead of duplicating the code

Patch Changes

  • Updated dependencies [64432bcb8]:
    • @astrojs/prism@0.7.0

0.13.0

Minor Changes

  • #4016 00fab4ce1 Thanks @bholmesdev! - The use of components and JSX expressions in Markdown are no longer supported by default.

    For long term support, migrate to the @astrojs/mdx integration for MDX support (including .mdx pages!).

    Not ready to migrate to MDX? Add the legacy flag to your Astro config to re-enable the previous Markdown support.

    // https://astro.build/config
export default defineConfig({
  legacy: {
    astroFlavoredMarkdown: true,
  },
});

Patch Changes

  • #4008 399d7e269 Thanks @bholmesdev! - Avoid parsing JSX, components, and Astro islands when using "plain" md mode. This brings markdown.mode: 'md' in-line with our docs description.

0.12.0

Minor Changes

Patch Changes

  • Updated dependencies [31f9c0bf0]:
    • @astrojs/prism@0.6.1

0.11.7

Patch Changes

0.11.6

Patch Changes

0.11.5

Patch Changes

0.11.4

Patch Changes

  • Updated dependencies [1cc5b7890]:
    • @astrojs/prism@0.5.0

0.11.3

Patch Changes

  • #3638 80c71c7c Thanks @tony-sull! - Fix: HTML comments in markdown code blocks should not be wrapped in JS comments

0.11.2

Patch Changes

0.11.1

Patch Changes

0.11.0

Minor Changes

Patch Changes

0.10.2

Patch Changes

0.10.1

Patch Changes

0.10.0

Minor Changes

  • #3410 cfae9760 Thanks @natemoo-re! - Significantly more stable behavior for "Markdown + Components" usage, which now handles component serialization much more similarly to MDX. Also supports switching between Components and Markdown without extra newlines, removes wrapping <p> tags from standalone components, and improves JSX expression handling.

0.9.4

Patch Changes

0.9.3

Patch Changes

  • #3234 de123b28 Thanks @JuanM04! - Removed rehype-slug in favor of our own implementation. The behavior of the slugging should remain the same

0.9.2

Patch Changes

0.9.1

Patch Changes

0.9.0

Minor Changes

  • 53162534 Thanks @FredKSchott! - - Removed renderMarkdownWithFrontmatter because it wasn't being used
    • All options of renderMarkdown are now required — see the exported interface AstroMarkdownOptions
    • New types: RemarkPlugin, RehypePlugin and ShikiConfig

0.8.2

Patch Changes

0.8.1

Patch Changes

0.8.0

Minor Changes

0.7.0

Minor Changes

  • #2824 0a3d3e51 Thanks @bholmesdev! - Change shiki to our default markdown syntax highlighter. This includes updates to all relevant starter projects that used Prism-specific styles.

Patch Changes

0.7.0-next.1

Patch Changes

0.7.0-next.0

Minor Changes

  • #2824 0a3d3e51 Thanks @bholmesdev! - Change shiki to our default markdown syntax highlighter. This includes updates to all relevant starter projects that used Prism-specific styles.

0.6.4

Patch Changes

0.6.3

Patch Changes

0.6.2

Patch Changes

0.6.1

Patch Changes

  • #2534 cfeaa941 Thanks @JuanM04! - Now you can use local plugins by passing a function instead of an import
  • #2518 2bc91543 Thanks @JuanM04! - Added the ability to use custom themes and langs with Shiki (<Code /> and @astrojs/markdown-remark)

0.6.1-next.2

Patch Changes

0.6.1-next.1

Patch Changes

  • #2534 cfeaa941 Thanks @JuanM04! - Now you can use local plugins by passing a function instead of an import
  • #2518 2bc91543 Thanks @JuanM04! - Added the ability to use custom themes and langs with Shiki (<Code /> and @astrojs/markdown-remark)

0.6.1-next.0

Patch Changes

0.6.0

Minor Changes

Patch Changes

  • Updated dependencies [45cea6ae]:
    • @astrojs/prism@0.4.0

0.5.0

Minor Changes

  • 679d4395: - Upgraded dependencies
    • Replaced remark-slug with rehype-slug because it was deprecated
    • Replaced @silvenon/remark-smartypants with remark-smartypants because its name was changed
    • Disable all built-in plugins when custom remark and/or rehype plugins are added
    • Removed remark-footnotes because remark-gfm now supports footnotes
    • Re-added remark-smartypants and rehype-slug to the default plugins list

0.4.0

Minor Changes

  • e6aaeff5: Initial release.

Patch Changes

  • Updated dependencies [e6aaeff5]
    • @astrojs/prism@0.3.0

0.4.0-next.2

Patch Changes

  • 00d2b625: Move gray-matter to deps

0.4.0-next.1

Patch Changes

  • 7eaabbb0: Fix bug where code blocks would not be escaped properly

0.4.0-next.0

Minor Changes

  • d84bfe71: Adds prism support within the Markdown plugin.

Patch Changes

  • Updated dependencies [d84bfe71]
    • @astrojs/prism@0.3.0-next.0

0.3.1

Patch Changes

  • b03f8771: Fix parsing of an empty <pre></pre> tag in markdown files, which expected the pre tag to have a child
  • b03f8771: Fix the importing of unified Plugin and UnifiedPlugin types

0.3.0

Minor Changes

  • 397d8f3d: Upgrade @astrojs/markdown-support dependencies. The remark-rehype@9 upgrade enables accessible footnotes with remark-footnotes.

0.2.4

Patch Changes

  • a421329f: Fix the left-brace issue

0.2.3

Patch Changes

  • 460e625: Move remaining missing dependencies

0.2.2

Patch Changes

  • 7015356: Move rehype-raw to a dependency

0.2.1

Patch Changes

  • 70f0a09: Added remark-slug to default plugins

0.2.0

Minor Changes

  • d396943: Add support for remark and rehype plugins for both .md pages and .astro pages using the <Markdown> component.

    For example, the astro.config.mjs could be updated to include the following. Read the Markdown documentation for more information.

    Note Enabling custom remarkPlugins or rehypePlugins removes Astro's built-in support for GitHub-flavored Markdown support, Footnotes syntax, Smartypants. You must explicitly add these plugins to your astro.config.mjs file, if desired.

    export default {
  markdownOptions: {
    remarkPlugins: ['remark-slug', ['remark-autolink-headings', { behavior: 'prepend' }]],
    rehypePlugins: ['rehype-slug', ['rehype-autolink-headings', { behavior: 'prepend' }]],
  },
};

Patch Changes

  • f83407e: Expose html to Astro.fetchContent (#571)

0.1.2

Patch Changes

  • f9f2da4: Add repository key to all package.json

0.1.1

Patch Changes

  • 50e6f49: Fixes issues with using astro via the create script