starlight-sidebar-topics-dropdown

Dropdown topic list for the Starlight Sidebar Topics plugin.

Documentation

Want to get started immediately?

Check out the starlight-sidebar-topics-dropdown getting started guide.

License

Licensed under the MIT license, Copyright © trueberryless.

See LICENSE for more information.

starlight-sidebar-topics-dropdown

0.5.1

Patch Changes

• 3a59211 Thanks @trueberryless! - Update keywords and description

0.5.0

Minor Changes

• #40 acf6f15 Thanks @trueberryless! - ⚠️ BREAKING CHANGE: This plugin now uses the Starlight Sidebar Topics plugin as a peer dependency. Please follow the upgrade guide below to migrate to the new version.

  1. Install the Starlight Sidebar Topics plugin:

     npm i starlight-sidebar-topics

  2. Update the starlight-sidebar-topics-dropdown component in your astro.config.mjs (use the starlight-sidebar-topics plugin instead):

     diff lang="js" // astro.config.mjs -import starlightSidebarTopicsDropdown from "starlight-sidebar-topics-dropdown"; +import starlightSidebarTopics from "starlight-sidebar-topics";

  3. Exchange the starlight-sidebar-topics-dropdown component with the starlight-sidebar-topics plugin and add a manual override for the Sidebar component where you can use the dropdown component from the starlight-sidebar-topics-dropdown component:

     `diff lang="js" // astro.config.mjs export default defineConfig({ integrations: [

     starlight({
       plugins: [

     • starlightSidebarTopicsDropdown([
     • starlightSidebarTopics([ // Your Starlight Sidebar Topics configuration here (unchanged). ]), ],
     • components: {
     • Sidebar: './src/components/Sidebar.astro',
     • }, }), ], }); `

  4. Create an Astro component to replace the default Starlight <Sidebar> component with which will render the topic list dropdown menu and re-use the default Starlight sidebar:

     ---
     // src/components/Sidebar.astro
     import Default from "@astrojs/starlight/components/Sidebar.astro";
     import TopicsDropdown from "starlight-sidebar-topics-dropdown/TopicsDropdown.astro";
     ---
     
     {/* Render the topics dropdown menu. */}
     <TopicsDropdown />
     {/* Render the default sidebar. */}
     <Default><slot /></Default>

  5. Update the schema import in src/content.config.ts:

     diff lang="ts" // src/content.config.ts -import { topicSchema } from "starlight-sidebar-topics-dropdown/schema"; +import { topicSchema } from "starlight-sidebar-topics/schema";

0.4.1

Patch Changes

• 01024d4 Thanks @trueberryless! - Small fixes and docs changes

0.4.0

Minor Changes

• #31 3193771 Thanks @trueberryless! - ⚠️ BREAKING CHANGE: The Starlight Sidebar Topics Dropdown plugin no longer provides the same "Unnested Sidebar" configuration like before. Please adapt your astro.config.mjs with the up-to-date guide on how to configure a "Unnested Sidebar".

• #31 db10526 Thanks @trueberryless! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now version 0.32.0.

  Please use the @astrojs/upgrade command to upgrade your project:

  npx @astrojs/upgrade

• #31 db10526 Thanks @trueberryless! - ⚠️ BREAKING CHANGE: The Starlight Sidebar Topics Dropdown plugin no longer overrides the <Pagination> component. If you were manually rendering starlight-sidebar-topics-dropdown/overrides/Pagination.astro in a custom override, you can now remove it.

0.3.0

Minor Changes

• #16 9edb5dc Thanks @trueberryless! - Adds support for Astro v5, drops support for Astro v4.

  ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.30.0.

  Please follow the upgrade guide to update your project.

  Note that the legacy.collections flag is not supported by this plugin and you should update your collections to use Astro's new Content Layer API.

Patch Changes

• #18 2039e9a Thanks @trueberryless! - Add Unnested Sidebar configuration

0.2.2

Patch Changes

• #11 88b99c5 Thanks @trueberryless! - Improves missing topic error messages by including the slug of the relevant page