@astrojs/markdoc

• 0.4.3

  Jul 19, 2023

  🐞 Patch Changes

  • #7706 4f6b5ae2b Thanks @Princesseuh! - Fix Markdoc integration not being able to import emitESMImage from Astro

  • Updated dependencies [72bbfac97, d401866f9, 4f6b5ae2b, 06c255716]:

    • astro@2.8.5
• 0.4.2

  Jul 11, 2023

  🐞 Patch Changes

  • #7593 c135633bf Thanks @bholmesdev! - Add a documentation link to the configuration error hint for those migration pre-v0.4.0 config to the latest version.

  • #7599 8df6a423c Thanks @bholmesdev! - Fix hyphens in Markdoc tag names causing build failures

  • Updated dependencies [904921cbe, 3669e2d27, 831dfd151]:

    • astro@2.8.1
• 0.4.1

  Jul 6, 2023

  🐞 Patch Changes

  • #7575 30d04db98 Thanks @bluwy! - Handle internal access change

  • Updated dependencies [9e5fafa2b, 9e5fafa2b, 9e5fafa2b, 6e9c29579, 9e5fafa2b, 9e5fafa2b]:

    • astro@2.8.0
• 0.4.0

  Jun 29, 2023

  🍿 Minor Changes

  • #7468 fb7af5511 Thanks @bholmesdev! - Updates the Markdoc config object for rendering Astro components as tags or nodes. Rather than importing components directly, Astro includes a new component() function to specify your component path. This unlocks using Astro components from npm packages and .ts files.

    Migration

    Update all component imports to instead import the new component() function and use it to render your Astro components:

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

  🐞 Patch Changes

  • #7467 f6feff7a2 Thanks @bholmesdev! - Restart the dev server whenever your markdoc config changes.

  • Updated dependencies [6dfd7081b, 83016795e, d3247851f, a3928016c, 2726098bc, f4fea3b02]:

    • astro@2.7.2
• 0.3.3

  Jun 10, 2023

  🐞 Patch Changes

  • #7351 a30f2f3de Thanks @bholmesdev! - Fix cloudflare build errors for a bad “./config” entrypoint and “node:crypto” getting included unexpectedly.

  • #7341 491c2db42 Thanks @bholmesdev! - Improve error message for unsupported Zod transforms from the content config.

  • Updated dependencies [491c2db42, 0a8d178c9]:

    • astro@2.6.3
• 0.3.2

  Jun 6, 2023

  🐞 Patch Changes

  • #7311 a11b62ee1 Thanks @bholmesdev! - Fix Markdoc type errors for render and defineMarkdocConfig() when using a TypeScript Markdoc config file.

  • #7309 2a4bb23b2 Thanks @bholmesdev! - Fix missing styles and scripts for components when using document: { render: null } in the Markdoc config.

  • Updated dependencies [8034edd9e]:

    • astro@2.6.1
• 0.3.1

  Jun 2, 2023

  🐞 Patch Changes

  • #7224 563293c5d Thanks @bholmesdev! - Allow HTML comments <!--like this--> in Markdoc files.

  • #7185 339529fc8 Thanks @bholmesdev! - Bring back improved style and script handling across content collection files. This addresses bugs found in a previous release to @astrojs/markdoc.

  • Updated dependencies [6e27f2f6d, 96ae37eb0, fea306936, 5156c4f90, 9e7366567, 339529fc8]:

    • astro@2.5.7
• 0.3.0

  May 30, 2023

  🍿 Minor Changes

  • #7244 bef3a75db Thanks @bholmesdev! - Remove the auto-generated $entry variable for Markdoc entries. To access frontmatter as a variable, you can pass entry.data as a prop where you render your content:

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

  🐞 Patch Changes

  • #7187 1efaef6be Thanks @bholmesdev! - Add support for syntax highlighting with Shiki. Apply to your Markdoc config using the extends property:

    import { defineMarkdocConfig } from '@astrojs/markdoc/config';
    import shiki from '@astrojs/markdoc/shiki';
    
    export default defineMarkdocConfig({
      extends: [
        shiki({
          /** Shiki config options */
        }),
      ],
    });

    Learn more in the @astrojs/markdoc README.

  • #7209 16b836411 Thanks @bholmesdev! - Add a built-in extension for syntax highlighting with Prism. Apply to your Markdoc config using the extends property:

    import { defineMarkdocConfig } from '@astrojs/markdoc/config';
    import prism from '@astrojs/markdoc/prism';
    
    export default defineMarkdocConfig({
      extends: [prism()],
    });

    Learn more in the @astrojs/markdoc README.

  • Updated dependencies [8b041bf57, 6c7df28ab, ee2aca80a, 7851f9258, bef3a75db, 52af9ad18, f5063d0a0, cf621340b, 2bda7fb0b, af3c5a2e2, f2f18b440]:

    • astro@2.5.6
• 0.2.3

  May 23, 2023

  🐞 Patch Changes

  • #7178 57e65d247 Thanks @bholmesdev! - Fix: revert Markdoc asset bleed changes. Production build issues were discovered that deserve a different fix.

  • Updated dependencies [904131aec, 57e65d247]:

    • astro@2.5.5
• 0.2.2

  May 22, 2023

  🐞 Patch Changes

  • #6758 f558a9e20 Thanks @bholmesdev! - Improve style and script handling across content collection files. This addresses style bleed present in @astrojs/markdoc v0.1.0

  • Updated dependencies [f558a9e20, b41963b77]:

    • astro@2.5.3
• 0.2.1

  May 20, 2023

  🐞 Patch Changes

  • #7141 a9e1cd7e5 Thanks @bholmesdev! - Fix inconsistent Markdoc heading IDs for documents with the same headings.

  • Updated dependencies [72f686a68, 319a0a7a0, 852d59a8d, 530fb9ebe, 3257dd289]:

    • astro@2.5.1
• 0.2.0

  May 18, 2023

  🍿 Minor Changes

  • #6850 c6d7ebefd Thanks @bholmesdev! - Content collections now support data formats including JSON and YAML. You can also create relationships, or references, between collections to pull information from one collection entry into another. Learn more on our updated Content Collections docs.

  • #7095 fb84622af Thanks @bholmesdev! - Generate heading ids and populate the headings property for all Markdoc files

  🐞 Patch Changes

  • #7111 6b4fcde37 Thanks @bholmesdev! - Fix: add headings to Markdoc render() return type.

  • #7104 826e02890 Thanks @bluwy! - Specify "files" field to only publish necessary files

  • Updated dependencies [4516d7b22, e186ecc5e, c6d7ebefd, 914c439bc, e9fc2c221, 075eee08f, 719002ca5, fc52681ba, fb84622af, cada10a46, cd410c5eb, 73ec6f6c1, 410428672, 763ff2d1e, c1669c001, 3d525efc9]:

    • astro@2.5.0
• 0.1.3

  May 9, 2023

  🐞 Patch Changes

  • #7045 3a9f72c7f Thanks @bholmesdev! - Improve Markdoc validation errors with full message and file preview.

  • Updated dependencies [48395c815, 630f8c8ef]:

    • astro@2.4.4
• 0.1.2

  May 4, 2023

  🐞 Patch 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">.

  • Updated dependencies [818252acd, 80e3d4d3d, 3326492b9, cac4a321e, 831b67cdb, 49514e4ce, 0883fd487]:

    • astro@2.4.0
• 0.1.1

  Apr 5, 2023

  🐞 Patch Changes

  • #6723 73fcc7627 Thanks @bholmesdev! - Fix: when using render: null in your config, content is now rendered without a wrapper element.

  • Updated dependencies [489dd8d69, a1a4f45b5, a1108e037, 8b88e4cf1, d54cbe413, 4c347ab51, ff0430786, 2f2e572e9, 7116c021a]:

    • astro@2.2.0
• 0.1.0

  Mar 28, 2023

  🍿 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).

    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:

    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

  Mar 24, 2023

  🐞 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

  Mar 22, 2023

  🐞 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

  Mar 21, 2023

  🐞 Patch Changes

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

  Mar 13, 2023

  🐞 Patch Changes

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