|
1 | 1 | # @primer/doctocat-nextjs |
2 | 2 |
|
| 3 | +## 0.8.0 |
| 4 | + |
| 5 | +### Minor Changes |
| 6 | + |
| 7 | +- [#73](https://github.com/primer/doctocat-nextjs/pull/73) [`a06099d`](https://github.com/primer/doctocat-nextjs/commit/a06099d65d36bdb361fc9a20b2b811990bb6d353) Thanks [@danielguillan](https://github.com/danielguillan)! - Add React 19 support |
| 8 | + |
| 9 | + This update is backwards compatible with React 18. However, it upgrades `@primer/react` to v38, which includes breaking changes such as the removal of the `Box` component and `sx` prop. Projects using this theme may need to update their code accordingly. |
| 10 | + - Updated React peer dependency to support React 19 |
| 11 | + - Updated @primer/react from v37.11.2 to v38.3.0 |
| 12 | + - Updated `@primer/react-brand` from v0.54.0 to v0.60.1 |
| 13 | + - Updated `framer-motion` from v12.4.0 to v12.23.24 |
| 14 | + - Updated `react-focus-on` from v3.9.4 to v3.10.0 |
| 15 | + - Migrated `Label` components to `Token` for React 19 compatibility |
| 16 | + - Fixed type errors in `ReactCodeBlock` and `getRelatedPages` for stricter React 19 types |
| 17 | + - Added explicit `as="button"` to `IconButton` and `as="input"` to `TextInput` components |
| 18 | + - Updated Next.js and related packages from v15.5.2 to v15.5.7 |
| 19 | + |
| 20 | +### Patch Changes |
| 21 | + |
| 22 | +- [#68](https://github.com/primer/doctocat-nextjs/pull/68) [`b75584e`](https://github.com/primer/doctocat-nextjs/commit/b75584edb6936a70ea94925fc743989422cc3d9a) Thanks [@janmaarten-a11y](https://github.com/janmaarten-a11y)! - Improve screen reader accessibility by updating sidebar navigation heading hierarchy. The sidebar title now uses a semantic `<Heading>` component with visually hidden text to clarify it's a navigation area, and is properly connected to the `<NavList>` via `aria-labelledby`. |
| 23 | + |
3 | 24 | ## 0.7.0 |
4 | 25 |
|
5 | 26 | ### Minor Changes |
6 | 27 |
|
7 | 28 | - [#65](https://github.com/primer/doctocat-nextjs/pull/65) [`dc680ec`](https://github.com/primer/doctocat-nextjs/commit/dc680ec51605bd7a40dedc71cd3bb107632035dd) Thanks [@rezrah](https://github.com/rezrah)! - Updated Next.js compatibility to v15.5.x, Nextra to v4, and fix React code block rendering |
8 | | - |
9 | 29 | - **Next.js v15.5.2**: Upgraded to latest stable version across all workspaces |
10 | 30 | - **Nextra v4 compatibility**: Updated type definitions for `ReactNode` titles |
11 | 31 | - **Fixed code block rendering**: Added client-side rendering for interactive code examples to handle React lazy components properly |
|
63 | 83 | ``` |
64 | 84 |
|
65 | 85 | - [#48](https://github.com/primer/doctocat-nextjs/pull/48) [`ce73c24`](https://github.com/primer/doctocat-nextjs/commit/ce73c24b2e4e924667bf7446a504bd88d8f2ccf0) Thanks [@rezrah](https://github.com/rezrah)! - - Fix inline code font-size in markdown headings. Now inherits size used in the heading. |
66 | | - |
67 | 86 | - Increased spacing below React code blocks, which was previously too small. |
68 | 87 |
|
69 | 88 | - [#50](https://github.com/primer/doctocat-nextjs/pull/50) [`5d67989`](https://github.com/primer/doctocat-nextjs/commit/5d679895408c1a58342419692db4234dfddefd80) Thanks [@rezrah](https://github.com/rezrah)! - Add `menu-position` frontmatter support for custom sidebar navigation ordering |
|
81 | 100 | ### Patch Changes |
82 | 101 |
|
83 | 102 | - [#41](https://github.com/primer/doctocat-nextjs/pull/41) [`e1ffb3a`](https://github.com/primer/doctocat-nextjs/commit/e1ffb3a630c51316a19e25869f731b4ef3660d2b) Thanks [@danielguillan](https://github.com/danielguillan)! - - Updated sidebar styles. |
84 | | - |
85 | 103 | - Added active header link as sidebar heading. |
86 | 104 | - Made active header the root item of breadcrumbs, if available. |
87 | 105 | - Made sidebar group headlines link to the index page. |
|
105 | 123 | ### Minor Changes |
106 | 124 |
|
107 | 125 | - [#30](https://github.com/primer/doctocat-nextjs/pull/30) [`cdcb65e`](https://github.com/primer/doctocat-nextjs/commit/cdcb65e087d647a6d61c87d9122f105dcda64e35) Thanks [@joshfarrant](https://github.com/joshfarrant)! - - Arbitrary links can now be added to the sidebar and header using the `Theme` component's `headerLinks` and `sidebarLinks` props. |
108 | | - |
109 | 126 | - Updated the header navigation to more closely visually align it with the existing Primer docs navigation. |
110 | 127 | - Removed `_meta.global.ts` and instead directly pass header and sidebar links into the Doctocat `Theme` component. |
111 | 128 |
|
|
135 | 152 | ### Patch Changes |
136 | 153 |
|
137 | 154 | - [#34](https://github.com/primer/doctocat-nextjs/pull/34) [`ccf198c`](https://github.com/primer/doctocat-nextjs/commit/ccf198cca25b1f021c5ae78b8e2760c141a77dcc) Thanks [@rezrah](https://github.com/rezrah)! - Collection of UI bugfixes: |
138 | | - |
139 | 155 | - Sidebar offset added to prevent links being trapped under fixed header |
140 | 156 | - Narrow viewport overflow bug fixed |
141 | 157 | - Table of contents presentation fixed on narrow viewport, and has improved presentation on wider breakpoints. |
|
184 | 200 | ### Minor Changes |
185 | 201 |
|
186 | 202 | - [#20](https://github.com/primer/doctocat-nextjs/pull/20) [`be8bc6a`](https://github.com/primer/doctocat-nextjs/commit/be8bc6af733ba40bdd4393b876b2653017d7e846) Thanks [@rezrah](https://github.com/rezrah)! - Dropped support for Next.js Pages router in favor of App Router + Nextra v4 |
187 | | - |
188 | 203 | - [Read the migration guide from `v0.1.0` to `v0.2.0`](https://github.com/primer/doctocat-nextjs/blob/main/migration-guides/v0.2.0-app-router.md) |
189 | 204 |
|
190 | 205 | ## 0.1.0 |
|
194 | 209 | - [#18](https://github.com/primer/doctocat-nextjs/pull/18) [`bfe68b1`](https://github.com/primer/doctocat-nextjs/commit/bfe68b14e8e3b4383ea41dcbf47373df8a130567) Thanks [@rezrah](https://github.com/rezrah)! - Upgraded internal framework to [Nextra v3](https://the-guild.dev/blog/nextra-3). |
195 | 210 |
|
196 | 211 | To migrate Doctocat to this release, follow these steps: |
197 | | - |
198 | 212 | 1. Install the latest version `npm i @primer/[email protected]` |
199 | 213 | 2. Rename your `next.config.js` to be `next.config.mjs`. Add `type="module"` to your `package.json` and update the file contents to match the following: |
200 | 214 |
|
|
270 | 284 | - [`6f21970`](https://github.com/primer/doctocat-nextjs/commit/6f21970c74f7635be89fc4cd20376d7fe5ca35e7) Thanks [@rezrah](https://github.com/rezrah)! - Switch hero image order with description and reduce `h2` block start margin |
271 | 285 |
|
272 | 286 | - [#6](https://github.com/primer/doctocat-nextjs/pull/6) [`afd4e17`](https://github.com/primer/doctocat-nextjs/commit/afd4e1762f6294a14942d415c693319a874cd3fb) Thanks [@rezrah](https://github.com/rezrah)! - - Add MDX to HTML overrides mechanism and apply to headings and anchors |
273 | | - |
274 | 287 | - Added anchor links to headings to match current functionality on primer.style |
275 | 288 |
|
276 | 289 | - [`b49f218`](https://github.com/primer/doctocat-nextjs/commit/b49f218e9bbc2de720476e21888956bee6081967) Thanks [@rezrah](https://github.com/rezrah)! - Removed sidebar links and added skip to main content a11y link |
|
0 commit comments