astro/packages/integrations/markdoc/CHANGELOG.md

@astrojs/markdoc

0.1.0

Minor Changes

• #6653 7c439868a Thanks @bholmesdev! - Simplify Markdoc configuration with a new markdoc.config.mjs file. This lets you import Astro components directly to render as Markdoc tags and nodes, without the need for the previous components property. This new configuration also unlocks passing variables to your Markdoc from the Content component (see the new docs).

  Migration

  Move any existing Markdoc config from your astro.config to a new markdoc.config.mjs file at the root of your project. This should be applied as a default export, with the optional defineMarkdocConfig() helper for autocomplete in your editor.

  This example configures an aside Markdoc tag. Note that components should be imported and applied to the render attribute directly, instead of passing the name as a string:

  // markdoc.config.mjs
  import { defineMarkdocConfig } from '@astrojs/markdoc/config';
  import Aside from './src/components/Aside.astro';
  
  export default defineMarkdocConfig({
    tags: {
      aside: {
        render: Aside,
      },
    },
  });
  

  You should also remove the components prop from your Content components. Since components are imported into your config directly, this is no longer needed.

  ---
  - import Aside from '../components/Aside.astro';
  import { getEntryBySlug } from 'astro:content';
  
  const entry = await getEntryBySlug('docs', 'why-markdoc');
  const { Content } = await entry.render();
  ---
  
  <Content
  - components={{ Aside }}
  />
  

Patch Changes

• Updated dependencies [1f783e320, 2e92e9aa9, adecda7d6, 386336441, 7c439868a, 25cd3e574, 4bf87c64f, fc0ed9c53]:
  • astro@2.1.8

0.0.5

Patch Changes

• #6630 cfcf2e2ff Thanks @bholmesdev! - Support automatic image optimization for Markdoc images when using experimental.assets. You can follow our Assets guide to enable this feature in your project. Then, start using relative or aliased image sources in your Markdoc files for automatic optimization:

  <!--Relative paths-->
  
  ![The Milky Way Galaxy](../assets/galaxy.jpg)
  
  <!--Or configured aliases-->
  
  ![Houston smiling and looking cute](~/assets/houston-smiling.jpg)
  

• Updated dependencies [b7194103e, cfcf2e2ff, 45da39a86, 7daef9a29]:

  • astro@2.1.7

0.0.4

Patch Changes

• #6588 f42f47dc6 Thanks @bholmesdev! - Allow access to content collection entry information (including parsed frontmatter and the entry slug) from your Markdoc using the $entry variable:

  ---
  title: Hello Markdoc!
  ---
  
  # {% $entry.data.title %}
  

• #6607 86273b588 Thanks @bholmesdev! - Fix: Update Markdoc renderer internals to remove unneeded dependencies

• #6622 b37b86540 Thanks @paulrudy! - Fix README instructions for installing Markdoc manually.

0.0.3

Patch Changes

• #6552 392ba3e4d Thanks @bluwy! - Fix integration return type

0.0.2

Patch Changes

• #6494 a13e9d7e3 Thanks @Yan-Thomas! - Consistency improvements to several package descriptions

0.0.1

Patch Changes

• #6209 fec583909 Thanks @bholmesdev! - Introduce the (experimental) @astrojs/markdoc integration. This unlocks Markdoc inside your Content Collections, bringing support for Astro and UI components in your content. This also improves Astro core internals to make Content Collections extensible to more file types in the future.

  You can install this integration using the astro add command:

  astro add markdoc
  

  Read the @astrojs/markdoc documentation for usage instructions, and browse the new with-markdoc starter to try for yourself.