Skip to content

Simplified setup

Pre-release
Pre-release

Choose a tag to compare

@tonyketcham tonyketcham released this 30 Jun 05:20
· 160 commits to main since this release

Introduces improvements to package interdependency ranges.

Previously, a version bump on a package could immediately outdate usage of previous versions of that package in tandem with a peer dependency. Now there are explicit ranges declared which can better follow semvar.

Cleans up the common, default use-case of Flatbread

Now you can import the Markdown Transformer and Source Filesystem from flatbread directly, instead of installing the plugins as separate. This is still cross-compatible with importing directly from the plugins themselves.

The example below highlights an example config of the typical markdown file flow:

import { defineConfig, markdownTransformer, filesystem } from 'flatbread';

const transformerConfig = {
  markdown: {
    gfm: true,
    externalLinks: true,
  },
};
export default defineConfig({
  source: filesystem(),
  transformer: markdownTransformer(transformerConfig),

  content: [
    {
      path: 'content/posts',
      collection: 'Post',
      refs: {
        authors: 'Author',
      },
    },
    {
      path: 'content/authors',
      collection: 'Author',
      refs: {
        friend: 'Author',
      },
    },
  ],
});

Node 16

From this point on, I'm only focused on supporting Node LTS which is v16+

Docs

Updated examples, fixed some links, and updated scripts 🫠