Skip to content

Commit 1932ecc

Browse files
Merge pull request #41 from trueberryless-org/changeset-release/main
[ci] release
2 parents 6f9f83f + 8a179f5 commit 1932ecc

File tree

8 files changed

+81
-80
lines changed

8 files changed

+81
-80
lines changed

.changeset/modern-jobs-fly.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/quiet-bats-wear.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.changeset/sad-bugs-pump.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

.changeset/tame-bags-march.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# starlight-sidebar-topics-dropdown-docs
22

3+
## 0.4.0
4+
5+
### Minor Changes
6+
7+
- [#40](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/pull/40) [`5401b3f`](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/commit/5401b3f1592b7c5e958b1778523f0a7a9f8f86e6) Thanks [@trueberryless](https://github.com/trueberryless)! - Update (and mostly remove) the documentation to match the new "just-a-component" package with the help of [HiDeoo](https://github.com/hideoo).
8+
9+
### Patch Changes
10+
11+
- [#43](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/pull/43) [`762c45d`](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/commit/762c45d58cb65ca0d14ca7b1073452112512b44e) Thanks [@trueberryless](https://github.com/trueberryless)! - Ignore bot contributors
12+
13+
- [#42](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/pull/42) [`f2d2b54`](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/commit/f2d2b54013fa059c11b4a71af074c2cb27e7f03c) Thanks [@trueberryless](https://github.com/trueberryless)! - Remove version badge and node adapter
14+
15+
- Updated dependencies [[`acf6f15`](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/commit/acf6f156d4e8eaa00b2205dbb89befbd5dea27c7)]:
16+
- starlight-sidebar-topics-dropdown@0.5.0
17+
318
## 0.3.3
419

520
### Patch Changes

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "starlight-sidebar-topics-dropdown-docs",
3-
"version": "0.3.3",
3+
"version": "0.4.0",
44
"private": true,
55
"description": "Starlight plugin to split your docs page into multiple subpages and switch between them with a dropdown menu in the sidebar.",
66
"homepage": "https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown",

packages/starlight-sidebar-topics-dropdown/CHANGELOG.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,69 @@
11
# starlight-sidebar-topics-dropdown
22

3+
## 0.5.0
4+
5+
### Minor Changes
6+
7+
- [#40](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/pull/40) [`acf6f15`](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/commit/acf6f156d4e8eaa00b2205dbb89befbd5dea27c7) Thanks [@trueberryless](https://github.com/trueberryless)! - ⚠️ **BREAKING CHANGE:** This plugin now uses the [Starlight Sidebar Topics](https://starlight-sidebar-topics.netlify.app/) plugin as a peer dependency. Please follow the upgrade guide below to migrate to the new version.
8+
9+
1. Install the [Starlight Sidebar Topics](https://starlight-sidebar-topics.netlify.app/) plugin:
10+
11+
```sh
12+
npm i starlight-sidebar-topics
13+
```
14+
15+
2. Update the `starlight-sidebar-topics-dropdown` plugin in your `astro.config.mjs` (use the `starlight-sidebar-topics` plugin instead):
16+
17+
```diff lang="js"
18+
// astro.config.mjs
19+
-import starlightSidebarTopicsDropdown from "starlight-sidebar-topics-dropdown";
20+
+import starlightSidebarTopics from "starlight-sidebar-topics";
21+
```
22+
23+
3. Exchange the `starlight-sidebar-topics-dropdown` plugin 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` plugin:
24+
25+
```diff lang="js"
26+
// astro.config.mjs
27+
export default defineConfig({
28+
integrations: [
29+
starlight({
30+
plugins: [
31+
- starlightSidebarTopicsDropdown([
32+
+ starlightSidebarTopics([
33+
// Your Starlight Sidebar Topics configuration here (unchanged).
34+
]),
35+
],
36+
+ components: {
37+
+ Sidebar: './src/components/Sidebar.astro',
38+
+ },
39+
}),
40+
],
41+
});
42+
```
43+
44+
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](https://starlight.astro.build/guides/overriding-components/#reuse-a-built-in-component):
45+
46+
```astro
47+
---
48+
// src/components/Sidebar.astro
49+
import Default from "@astrojs/starlight/components/Sidebar.astro";
50+
import TopicsDropdown from "starlight-sidebar-topics-dropdown/TopicsDropdown.astro";
51+
---
52+
53+
{/* Render the topics dropdown menu. */}
54+
<TopicsDropdown />
55+
{/* Render the default sidebar. */}
56+
<Default><slot /></Default>
57+
```
58+
59+
5. Update the schema import in `src/content.config.ts`:
60+
61+
```diff lang="ts"
62+
// src/content.config.ts
63+
-import { topicSchema } from "starlight-sidebar-topics-dropdown/schema";
64+
+import { topicSchema } from "starlight-sidebar-topics/schema";
65+
```
66+
367
## 0.4.1
468
569
### Patch Changes

packages/starlight-sidebar-topics-dropdown/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "starlight-sidebar-topics-dropdown",
3-
"version": "0.4.1",
3+
"version": "0.5.0",
44
"description": "Starlight plugin to split your docs page into multiple subpages and switch between them with a dropdown menu in the sidebar.",
55
"keywords": [
66
"starlight",

0 commit comments

Comments
 (0)