Skip to content

Commit 6070b02

Browse files
author
Dimitri POSTOLOV
authoredJan 17, 2024
[v3] rename frontmatter.sidebar_label to frontmatter.sidebarTitle (#2641)
* aa * rename `frontmatter.sidebar_label` to `frontmatter.sidebarTitle` * aaa * yo * Update .changeset/strong-ads-serve.md * aa * use new tailwindcss class `size` * update tsup * update flexsearch * load flexsearch dynamically to reduce bundle size * add changeset
·
nextra-theme-docs@4.0.0-rc.0nextra@3.0.0-alpha.13
1 parent ce1ab6a commit 6070b02

34 files changed

+341
-553
lines changed
 

‎.changeset/early-walls-hammer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
- ❌ remove Nextra middleware `nextra/locales`
88

9-
- ❌ remove `parseFileName` from `nextra/utils`
9+
- ❌ remove `parseFileName` from `nextra/remove-links`
1010

1111
- ❌ remove `nextra/filter-route-locale`
1212

‎.changeset/fair-crabs-double.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'nextra-theme-docs': patch
3+
---
4+
5+
load `flexsearch` dynamically to reduce bundle size

‎.changeset/little-students-care.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
'nextra': minor
44
---
55

6-
add `frontmatter.sidebar_label` support for setting page label in sidebar via frontmatter
6+
add `frontmatter.sidebarTitle` support for setting page label in sidebar via frontmatter

‎.changeset/polite-olives-impress.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'nextra-theme-docs': minor
3+
'nextra': minor
4+
---
5+
6+
rename `frontmatter.sidebar_label` to `frontmatter.sidebarTitle`

‎.changeset/strong-ads-serve.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'nextra-theme-docs': minor
3+
'nextra': minor
4+
---
5+
6+
move `removeLinks` function from `nextra-theme-docs` to `nextra/utils`

‎.eslintrc.cjs

+1
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ module.exports = {
6161
'sonarjs/no-small-switch': 'error',
6262
'prefer-const': ['error', { destructuring: 'all' }],
6363
'unicorn/prefer-array-index-of': 'error',
64+
'sonarjs/no-unused-collection': 'error',
6465
// todo: enable
6566
'@typescript-eslint/no-explicit-any': 'off',
6667
'@typescript-eslint/no-non-null-assertion': 'off',

‎docs/components/index-page/index.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ export const IndexPage = () => (
484484
.
485485
</p>
486486
</div>
487-
<div className="absolute w-full h-full inset-0 hidden sm:block bg-[linear-gradient(to_right,white_250px,_transparent)] dark:bg-[linear-gradient(to_right,#202020_250px,_transparent)] z-[1]" />
487+
<div className="absolute size-full inset-0 hidden sm:block bg-[linear-gradient(to_right,white_250px,_transparent)] dark:bg-[linear-gradient(to_right,#202020_250px,_transparent)] z-[1]" />
488488
<video
489489
autoPlay
490490
loop

‎docs/package.json

+3-4
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@
2323
"@svgr/webpack": "^8.0.1",
2424
"@types/node": "^20.0.0",
2525
"@types/react": "^18.2.23",
26-
"autoprefixer": "^10.4.15",
27-
"eslint": "^8.30.0",
28-
"postcss": "^8.4.31",
29-
"tailwindcss": "^3.3.3"
26+
"autoprefixer": "^10.4.16",
27+
"postcss": "^8.4.33",
28+
"tailwindcss": "^3.4.1"
3029
}
3130
}

‎docs/pages/docs/guide/built-ins.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ your content:
3434
href="/docs/guide/built-ins/steps"
3535
/>
3636
<Cards.Card
37-
icon={<FolderTreeIcon className="h-5 w-5" />}
37+
icon={<FolderTreeIcon className="size-5" />}
3838
title="FileTree"
3939
href="/docs/guide/built-ins/filetree"
4040
/>

‎examples/swr-site/next.config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export function getStaticProps() {
2626
{
2727
name: 'virtual-page',
2828
route: '/en/virtual-page',
29-
frontMatter: { sidebar_label: 'Virtual Page' }
29+
frontMatter: { sidebarTitle: 'Virtual Page' }
3030
}
3131
]
3232
}

‎examples/swr-site/package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@
3636
},
3737
"devDependencies": {
3838
"@next/bundle-analyzer": "^13.4.19",
39-
"autoprefixer": "^10.4.15",
40-
"postcss": "^8.4.31",
41-
"tailwindcss": "^3.3.3"
39+
"autoprefixer": "^10.4.16",
40+
"postcss": "^8.4.33",
41+
"tailwindcss": "^3.4.1"
4242
},
4343
"nextBundleAnalysis": {
4444
"budget": 358400,

‎package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@
3333
"eslint-plugin-react": "7.33.2",
3434
"eslint-plugin-react-hooks": "4.6.0",
3535
"eslint-plugin-sonarjs": "^0.23.0",
36-
"eslint-plugin-tailwindcss": "3.13.1",
36+
"eslint-plugin-tailwindcss": "3.14.0",
3737
"eslint-plugin-typescript-sort-keys": "3.1.0",
3838
"eslint-plugin-unicorn": "50.0.1",
3939
"prettier": "3.0.3",
4040
"prettier-plugin-pkg": "0.18.0",
4141
"prettier-plugin-tailwindcss": "0.5.11",
4242
"rimraf": "5.0.5",
43-
"tsup": "7.2.0",
43+
"tsup": "8.0.1",
4444
"tsx": "^4.7.0",
4545
"turbo": "1.11.3",
4646
"typescript": "5.3.3"
@@ -52,7 +52,7 @@
5252
},
5353
"patchedDependencies": {
5454
"@changesets/assemble-release-plan@5.2.4": "patches/@changesets__assemble-release-plan@5.2.4.patch",
55-
"tsup@7.2.0": "patches/tsup@7.2.0.patch"
55+
"tsup@8.0.1": "patches/tsup@8.0.1.patch"
5656
}
5757
}
5858
}

‎packages/nextra-theme-blog/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,14 @@
7070
"concurrently": "^8.2.1",
7171
"next": "^13.5.3",
7272
"nextra": "workspace:*",
73-
"postcss": "^8.4.31",
73+
"postcss": "^8.4.33",
7474
"postcss-cli": "^10.1.0",
7575
"postcss-import": "^15.1.0",
7676
"postcss-lightningcss": "^1.0.0",
7777
"react": "^18.2.0",
7878
"react-cusdis": "^2.1.3",
7979
"react-dom": "^18.2.0",
80-
"tailwindcss": "^3.3.3",
80+
"tailwindcss": "^3.4.1",
8181
"vitest": "^1.2.0"
8282
},
8383
"sideEffects": false

‎packages/nextra-theme-docs/package.json

+3-4
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
"@popperjs/core": "^2.11.8",
4141
"clsx": "^2.0.0",
4242
"escape-string-regexp": "^5.0.0",
43-
"flexsearch": "0.7.31",
43+
"flexsearch": "^0.7.43",
4444
"focus-visible": "^5.2.0",
4545
"intersection-observer": "^0.12.2",
4646
"next-themes": "^0.2.1",
@@ -50,21 +50,20 @@
5050
"devDependencies": {
5151
"@tailwindcss/nesting": "^0.0.0-insiders.565cd3e",
5252
"@testing-library/react": "^14.0.0",
53-
"@types/flexsearch": "^0.7.4",
5453
"@types/react": "^18.2.23",
5554
"@types/react-dom": "^18.2.8",
5655
"@vitejs/plugin-react": "^4.1.0",
5756
"concurrently": "^8.2.1",
5857
"jsdom": "^23.0.0",
5958
"next": "^13.5.6",
6059
"nextra": "workspace:*",
61-
"postcss": "^8.4.31",
60+
"postcss": "^8.4.33",
6261
"postcss-cli": "^10.1.0",
6362
"postcss-import": "^15.1.0",
6463
"postcss-lightningcss": "^1.0.0",
6564
"react": "^18.2.0",
6665
"react-dom": "^18.2.0",
67-
"tailwindcss": "^3.3.3",
66+
"tailwindcss": "^3.4.1",
6867
"vitest": "^1.2.0"
6968
},
7069
"sideEffects": [

‎packages/nextra-theme-docs/src/components/flexsearch.tsx

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import cn from 'clsx'
2-
// flexsearch types are incorrect, they were overwritten in tsconfig.json
3-
import FlexSearch from 'flexsearch'
2+
import type { Document } from 'flexsearch'
43
import type { SearchData } from 'nextra'
54
import { useRouter } from 'nextra/hooks'
65
import type { ReactElement, ReactNode } from 'react'
@@ -10,7 +9,7 @@ import type { SearchResult } from '../types'
109
import { HighlightMatches } from './highlight-matches'
1110
import { Search } from './search'
1211

13-
type SectionIndex = FlexSearch.Document<
12+
type SectionIndex = Document<
1413
{
1514
id: string
1615
url: string
@@ -22,7 +21,7 @@ type SectionIndex = FlexSearch.Document<
2221
['title', 'content', 'url', 'display']
2322
>
2423

25-
type PageIndex = FlexSearch.Document<
24+
type PageIndex = Document<
2625
{
2726
id: number
2827
title: string
@@ -60,12 +59,14 @@ const loadIndexesImpl = async (
6059
basePath: string,
6160
locale: string
6261
): Promise<void> => {
63-
const response = await fetch(
64-
`${basePath}/_next/static/chunks/nextra-data-${locale}.json`
65-
)
66-
const searchData = (await response.json()) as SearchData
62+
const [searchData, Document] = await Promise.all([
63+
fetch(`${basePath}/_next/static/chunks/nextra-data-${locale}.json`).then(
64+
response => response.json() as Promise<SearchData>
65+
),
66+
import('flexsearch').then(mod => mod.default.Document)
67+
])
6768

68-
const pageIndex: PageIndex = new FlexSearch.Document({
69+
const pageIndex: PageIndex = new Document({
6970
cache: 100,
7071
tokenize: 'full',
7172
document: {
@@ -80,7 +81,7 @@ const loadIndexesImpl = async (
8081
}
8182
})
8283

83-
const sectionIndex: SectionIndex = new FlexSearch.Document({
84+
const sectionIndex: SectionIndex = new Document({
8485
cache: 100,
8586
tokenize: 'full',
8687
document: {

‎packages/nextra-theme-docs/src/components/nav-links.tsx

+6-6
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import type { DocsThemeConfig } from '../index'
99

1010
interface NavLinkProps {
1111
currentIndex: number
12-
flatDirectories: Item[]
12+
flatDocsDirectories: Item[]
1313
}
1414

1515
const classes = {
@@ -19,16 +19,16 @@ const classes = {
1919
icon: cn('_inline _h-5 _shrink-0')
2020
}
2121

22-
export const NavLinks = ({
23-
flatDirectories,
22+
export function NavLinks({
23+
flatDocsDirectories,
2424
currentIndex
25-
}: NavLinkProps): ReactElement | null => {
25+
}: NavLinkProps): ReactElement | null {
2626
const themeConfig = useThemeConfig()
2727
const nav = themeConfig.navigation
2828
const navigation: Exclude<DocsThemeConfig['navigation'], boolean> =
2929
typeof nav === 'boolean' ? { prev: nav, next: nav } : nav
30-
let prev = navigation.prev && flatDirectories[currentIndex - 1]
31-
let next = navigation.next && flatDirectories[currentIndex + 1]
30+
let prev = navigation.prev && flatDocsDirectories[currentIndex - 1]
31+
let next = navigation.next && flatDocsDirectories[currentIndex + 1]
3232

3333
if (prev && !prev.isUnderCurrentDocsTree) prev = false
3434
if (next && !next.isUnderCurrentDocsTree) next = false

‎packages/nextra-theme-docs/src/components/navbar.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ export function Navbar({ items }: NavBarProps): ReactElement {
8989
<div
9090
className={cn(
9191
'nextra-nav-container-blur',
92-
'_pointer-events-none _absolute _z-[-1] _h-full _w-full _bg-white dark:_bg-dark',
92+
'_pointer-events-none _absolute _z-[-1] _size-full _bg-white dark:_bg-dark',
9393
'_shadow-[0_2px_4px_rgba(0,0,0,.02),0_1px_0_rgba(0,0,0,.06)] dark:_shadow-[0_-1px_0_rgba(255,255,255,.1)_inset]',
9494
'contrast-more:_shadow-[0_0_0_1px_#000] contrast-more:dark:_shadow-[0_0_0_1px_#fff]'
9595
)}

‎packages/nextra-theme-docs/src/components/search.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -249,12 +249,12 @@ export function Search({
249249
>
250250
{error ? (
251251
<span className="_flex _select-none _justify-center _gap-2 _p-8 _text-center _text-sm _text-red-500">
252-
<InformationCircleIcon className="_h-5 _w-5" />
252+
<InformationCircleIcon className="_size-5" />
253253
{renderString(themeConfig.search.error)}
254254
</span>
255255
) : loading ? (
256256
<span className="_flex _select-none _justify-center _gap-2 _p-8 _text-center _text-sm _text-gray-400">
257-
<SpinnerIcon className="_h-5 _w-5 _animate-spin" />
257+
<SpinnerIcon className="_size-5 _animate-spin" />
258258
{renderComponent(themeConfig.search.loading)}
259259
</span>
260260
) : results.length > 0 ? (

‎packages/nextra-theme-docs/src/components/toc.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import cn from 'clsx'
22
import type { Heading } from 'nextra'
3+
import { removeLinks } from 'nextra/remove-links'
34
import type { ReactElement } from 'react'
45
import { useEffect, useRef } from 'react'
56
import scrollIntoView from 'scroll-into-view-if-needed'
67
import { useActiveAnchor, useThemeConfig } from '../contexts'
78
import { renderComponent } from '../utils'
8-
import { removeLinks } from '../utils/remove-links'
99
import { Anchor } from './anchor'
1010
import { BackToTop } from './back-to-top'
1111

‎packages/nextra-theme-docs/src/mdx-components.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ function Summary({
158158
<ArrowRightIcon
159159
className={cn(
160160
'_order-first', // if prettier formats `summary` it will have unexpected margin-top
161-
'_w-4 _h-4 _shrink-0 _mx-1.5',
161+
'_size-4 _shrink-0 _mx-1.5',
162162
'rtl:_rotate-180 [[data-expanded]>summary>&]:_rotate-90 _transition'
163163
)}
164164
pathClassName="_stroke-[3px]"
@@ -231,7 +231,7 @@ function Body({ children }: { children: ReactNode }): ReactElement {
231231
{renderComponent(themeContext.bottomContent)}
232232
{activeType !== 'page' && themeContext.pagination && (
233233
<NavLinks
234-
flatDirectories={flatDocsDirectories}
234+
flatDocsDirectories={flatDocsDirectories}
235235
currentIndex={activeIndex}
236236
/>
237237
)}

‎packages/nextra-theme-docs/tsconfig.json

+1-5
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@
1212
"moduleResolution": "node",
1313
"lib": ["ESNext", "DOM"],
1414
"types": ["vitest/globals"],
15-
"resolveJsonModule": true,
16-
"paths": {
17-
// fixes incorrect types for flexsearch https://github.com/nextapps-de/flexsearch/issues/392#issuecomment-1552286514
18-
"flexsearch": ["./node_modules/@types/flexsearch"]
19-
}
15+
"resolveJsonModule": true
2016
}
2117
}

0 commit comments

Comments
 (0)
Please sign in to comment.