Mirror of
Merge pull request #41 from trueberryless-org/changeset-release/main
[ci] release
authored by
trueberryless
and committed by
GitHub
1932eccc
6f9f83f8
+81
-80
-5
.changeset/modern-jobs-fly.md
-5
.changeset/modern-jobs-fly.md
-5
.changeset/quiet-bats-wear.md
-5
.changeset/quiet-bats-wear.md
-63
.changeset/sad-bugs-pump.md
-63
.changeset/sad-bugs-pump.md
···
1
-
---
2
-
"starlight-sidebar-topics-dropdown": minor
3
-
---
4
-
5
-
⚠️ **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.
6
-
7
-
1. Install the [Starlight Sidebar Topics](https://starlight-sidebar-topics.netlify.app/) plugin:
8
-
9
-
```sh
10
-
npm i starlight-sidebar-topics
11
-
```
12
-
13
-
2. Update the `starlight-sidebar-topics-dropdown` plugin in your `astro.config.mjs` (use the `starlight-sidebar-topics` plugin instead):
14
-
15
-
```diff lang="js"
16
-
// astro.config.mjs
17
-
-import starlightSidebarTopicsDropdown from "starlight-sidebar-topics-dropdown";
18
-
+import starlightSidebarTopics from "starlight-sidebar-topics";
19
-
```
20
-
21
-
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:
22
-
23
-
```diff lang="js"
24
-
// astro.config.mjs
25
-
export default defineConfig({
26
-
integrations: [
27
-
starlight({
28
-
plugins: [
29
-
- starlightSidebarTopicsDropdown([
30
-
+ starlightSidebarTopics([
31
-
// Your Starlight Sidebar Topics configuration here (unchanged).
32
-
]),
33
-
],
34
-
+ components: {
35
-
+ Sidebar: './src/components/Sidebar.astro',
36
-
+ },
37
-
}),
38
-
],
39
-
});
40
-
```
41
-
42
-
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):
43
-
44
-
```astro
45
-
---
46
-
// src/components/Sidebar.astro
47
-
import Default from '@astrojs/starlight/components/Sidebar.astro';
48
-
import TopicsDropdown from 'starlight-sidebar-topics-dropdown/TopicsDropdown.astro';
49
-
---
50
-
51
-
{/* Render the topics dropdown menu. */}
52
-
<TopicsDropdown />
53
-
{/* Render the default sidebar. */}
54
-
<Default><slot /></Default>
55
-
```
56
-
57
-
5. Update the schema import in `src/content.config.ts`:
58
-
59
-
```diff lang="ts"
60
-
// src/content.config.ts
61
-
-import { topicSchema } from "starlight-sidebar-topics-dropdown/schema";
62
-
+import { topicSchema } from "starlight-sidebar-topics/schema";
63
-
```
-5
.changeset/tame-bags-march.md
-5
.changeset/tame-bags-march.md
+15
docs/CHANGELOG.md
+15
docs/CHANGELOG.md
···
1
1
# starlight-sidebar-topics-dropdown-docs
2
2
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
+
3
18
## 0.3.3
4
19
5
20
### Patch Changes
+1
-1
docs/package.json
+1
-1
docs/package.json
···
1
1
{
2
2
"name": "starlight-sidebar-topics-dropdown-docs",
3
-
"version": "0.3.3",
3
+
"version": "0.4.0",
4
4
"private": true,
5
5
"description": "Starlight plugin to split your docs page into multiple subpages and switch between them with a dropdown menu in the sidebar.",
6
6
"homepage": "https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown",