Skip to content

v0.14.0

Compare
Choose a tag to compare
@github-actions github-actions released this 12 Nov 14:51
· 2 commits to main since this release

What's Changed

Breaking Changes 🛠

Decouple navigation from file system locations by @ntotten in #211

Before this, the top navigation ID correlated with the file system directory path. This meant that the sidebar item ID was concatenated with the top navigation ID, linking them closely together:

config = {
  topNavigation: [{ label: "Documentation", id: "docs" }],
  sidebar: {
    docs: ["intro", "getting-started"],
  },
};

This meant that the sidebar item ID is coupled to the top navigation ID. This made it difficult to move documents around without breaking the sidebar navigation. The resulting document IDs were: ['/docs/intro', '/docs/getting-started'].

The top navigation ID is now decoupled from the file system path. This means that the sidebar item ID is no longer concatenated with the top navigation ID. As a result, you will need to specify the full path to the document in the sidebar:

config = {
  topNavigation: [{ label: "Documentation", id: "docs" }],
  sidebar: {
    docs: ["/docs/intro", "/docs/getting-started"],
  },
};

Be sure to also add these paths to the docs config:

config = {
  docs: {
    files: "/docs/**/*.{md,mdx}",
  },
};

or for multiple directories:

config = {
  docs: [{ files: "/docs/**/*.{md,mdx}" }, { files: "/guides/**/*.{md,mdx}" }],
};

Bug Fixes 🐛

Other Changes 🔄

  • feat: Add documentation for components by @mosch in #212
  • build(deps-dev): bump @types/express from 4.17.21 to 5.0.0 by @dependabot in #283
  • build(deps-dev): bump the eslint-dependencies group across 1 directory with 3 updates by @dependabot in #323
  • build(deps): bump react-error-boundary from 4.0.13 to 4.1.2 by @dependabot in #284

Full Changelog: v0.13.7...v0.14.0