Skip to content

Releases: souporserious/mdxts

[email protected]

16 Apr 20:01
Compare
Choose a tag to compare

Minor Changes

  • 435c5e8: Allow overriding frontMatter type through createSource generic.

    import { createSource } from "mdxts";
    
    export const allDocs = createSource<{
      frontMatter: {
        title: string;
        description: string;
        date: string;
        tags?: string[];
      };
    }>("docs/*.mdx");
  • fac626b: Adds front matter type validation using the generic passed to createSource:

    import { createSource } from "mdxts";
    
    export const allPosts = createSource<{
      frontMatter: {
        title: string;
        date: Date;
        summary: string;
        tags?: string[];
      };
    }>("posts/**/*.mdx", { baseDirectory: "posts" });
    ---
    title: Hello World
    date: 2021-01-01
    ---
    
    # Hello World
    
    This is a post.

    Results in the following type error:

    Error: Front matter data is incorrect or missing
    [/posts/markdown-guide.mdx] Type '{}' does not satisfy the expected type 'frontMatter'.
    Type '{}' is missing the following properties from type 'frontMatter': summary
    

Patch Changes

  • 7327000: Fixes WebSocket error during local development when first loading the page:

    InvalidStateError: Failed to execute 'send' on 'WebSocket': Still in CONNECTING state.
    

[email protected]

04 Apr 00:08
faad5c7
Compare
Choose a tag to compare

Minor Changes

  • 32c9686: Removes private Editor and Preview components and related dependencies to reduce bundle size.
  • 6fcd390: Adds initial support for Next.js Turbopack locally.

Patch Changes

  • 9feac19: Removes processing MDX files with Webpack loader since it is now handled through remark and getAllData.

[email protected]

04 Apr 17:55
1296956
Compare
Choose a tag to compare

Patch Changes

  • 300587c: Fixes ESM chalk error by downgrading to previous version.

[email protected]

04 Apr 17:10
c74bfbf
Compare
Choose a tag to compare

Patch Changes

  • 24f9a9b: Fixes fetching the wrong version when reformatting the mdxts package version downloaded from examples.
  • acfc425: Fixes undefined in message when using example option in CLI.
  • 9a69392: Adds link to blog example when first onboarding through the CLI.
  • 96e401b: Fixes incorrect CLI outdated version comparison.

[email protected]

04 Apr 00:08
faad5c7
Compare
Choose a tag to compare

Patch Changes

  • 77c4c10: Improves CLI onboarding by prompting to copy the blog example if not run in a project.

[email protected]

03 Apr 08:22
9f692de
Compare
Choose a tag to compare

Minor Changes

  • 88b9e10: Simplify MDXContent to not include plugins by default and instead expose new remarkPlugins, rehypePlugins, and baseUrl props.
  • ad09ddb: Moves frontMatter from Webpack loader to static getAllData utility so front matter metadata is available when using the createSource.all method.
  • b42a275: Removes ShouldRenderTitle transformation from Webpack loader and now adds it through a remark plugin.

Patch Changes

  • e76e18e: Fixes headings getting incremented ids when duplicates do not exist.

[email protected]

03 Apr 08:22
9f692de
Compare
Choose a tag to compare

Patch Changes

  • 332af8f: Only install mdxts dependency when onboarding.

[email protected]

02 Apr 17:40
7b02fe1
Compare
Choose a tag to compare

Patch Changes

  • f35df99: Fixes the getGitMetadata utility erroring when running MDXTS in a project that does not have git instantiated.
  • fa4d329: Fixes the Webpack loader not updating dynamic imports when the createSource file pattern directory changes.
  • d651cd0: Filter empty lines from git log to avoid getGitMetadata erroring related to #81.
  • d3fc5ac: Throw more helpful error if MDX code block is empty.

[email protected]

26 Mar 20:49
681c067
Compare
Choose a tag to compare

Minor Changes

  • a7bae02: Reformat createSource.all method to return an array instead of an object.

    const allDocs = createSource('docs/*.mdx')
    ---Object.values(allDocs.all()).map((doc) => ...)
    +++allDocs.all().map((doc) => ...)
  • 7942259: Move source item gitMetadata to top-level fields.

    import { MetadataRoute } from 'next'
    import { allData } from 'data'
    
    export default function sitemap(): MetadataRoute.Sitemap {
      return Object.values(allData.all()).map((data) => ({
        url: `https://mdxts.dev/${data.pathname}`,
    ---    lastModified: data.gitMetadata.updatedAt,
    +++    lastModified: data.updatedAt,
      }))
    }
  • 305d1a4: Throw error if attempting to use git metadata and repo is shallowly cloned.

  • ba37a05: Adds url field to source item that concatenates siteUrl with pathname.

  • e487e1f: Adds a remark plugin to transform relative ordered links:

    --- [./02.rendering.mdx]
    +++ [./rendering]

Patch Changes

  • fc74fb9: Fixes CodeBlock allowCopy prop still showing copy button when set to false.
  • b7da458: Fixes code blocks being transformed when wrapping headings in ShouldRenderTitle.

[email protected]

24 Mar 22:16
Compare
Choose a tag to compare

Minor Changes

  • 90863ba: Adds RSS feed helper for createSource and mergeSources:

    // app/rss.xml/route.js
    import { allData } from "data";
    
    export async function GET() {
      const feed = allData.rss({
        title: "MDXTS - The Content & Documentation SDK for React",
        description: "Type-safe content and documentation.",
        copyright: ${new Date().getFullYear()} @souporserious`,
      });
      return new Response(feed, {
        headers: {
          "Content-Type": "application/rss+xml",
        },
      });
    }
  • 4121eb9: Replaces remark-typography with the more popular remark-smartypants package.

  • 7367b1d: Adds ISO 8601 duration to readingTime metadata for easier use with time HTML element.

  • e04f4f6: Adds createdAt, updatedAt, and authors fields to createSource item. This implementation is inspired by unified-infer-git-meta.

  • 9c6d65a: Adds readingTime field to createSource item using rehype-infer-reading-time-meta.

  • fb0299d: Adds support for Codesandbox embeds in MDX.

Patch Changes

  • 6e68e11: Fixes an issue where saving content did not trigger a fast refresh locally. This adds a web socket server component to the Content component to ensure a refresh is always triggered.
  • fafdcc6: Adds default feedLinks.rss option when creating rss feeds.
  • df41a98: Fixes empty createSource when targeting JavaScript/TypeScript without an index file.