use title package in nextra to determine sidebar title based on pag…

…ename (#814) * use `title` package in nextra to determine sidebar title based on pagename * update snapshots * fix types check
shuding · Sep 6, 2022 · 93d028b · 93d028b
1 parent d6d5ab8
commit 93d028b
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 11 deletions.
diff --git a/.changeset/nice-shrimps-cheat.md b/.changeset/nice-shrimps-cheat.md
@@ -0,0 +1,5 @@
+---
+'nextra': patch
+---
+
+use `title` package in nextra to determine sidebar title based on pagename
diff --git a/packages/nextra-theme-docs/src/utils/normalize-pages.ts b/packages/nextra-theme-docs/src/utils/normalize-pages.ts
@@ -1,7 +1,7 @@
 import { PageMapItem } from 'nextra'
 import { DEFAULT_PAGE_THEME } from '../constants'
 import { PageTheme } from '../types'
-import { Folder, MdxFile } from 'nextra/src/types'
+import { Folder, MdxFile } from 'nextra'
 
 function extendMeta(
   meta: string | Record<string, any> = {},

diff --git a/packages/nextra/__test__/__snapshots__/context.test.ts.snap b/packages/nextra/__test__/__snapshots__/context.test.ts.snap
@@ -1035,7 +1035,7 @@ exports[`context > getAllPages() > should work 1`] = `
                 "kind": "MdxPage",
                 "locale": "en-US",
                 "meta": {
-                  "title": "loooooooooooooooooooong-title",
+                  "title": "Loooooooooooooooooooong Title",
                 },
                 "name": "loooooooooooooooooooong-title",
                 "route": "/docs/advanced/more/loooooooooooooooooooong-title",
@@ -1279,7 +1279,7 @@ exports[`context > getAllPages() > should work 1`] = `
         "kind": "MdxPage",
         "locale": "en-US",
         "meta": {
-          "title": "code-block-without-language",
+          "title": "Code Block without Language",
         },
         "name": "code-block-without-language",
         "route": "/docs/code-block-without-language",
@@ -2749,7 +2749,7 @@ exports[`context > getCurrentLevelPages() > should work 1`] = `
             "kind": "MdxPage",
             "locale": "en-US",
             "meta": {
-              "title": "loooooooooooooooooooong-title",
+              "title": "Loooooooooooooooooooong Title",
             },
             "name": "loooooooooooooooooooong-title",
             "route": "/docs/advanced/more/loooooooooooooooooooong-title",
@@ -2993,7 +2993,7 @@ exports[`context > getCurrentLevelPages() > should work 1`] = `
     "kind": "MdxPage",
     "locale": "en-US",
     "meta": {
-      "title": "code-block-without-language",
+      "title": "Code Block without Language",
     },
     "name": "code-block-without-language",
     "route": "/docs/code-block-without-language",
@@ -3162,7 +3162,7 @@ exports[`context > getPagesUnderRoute() > should work 1`] = `
         "kind": "MdxPage",
         "locale": "en-US",
         "meta": {
-          "title": "loooooooooooooooooooong-title",
+          "title": "Loooooooooooooooooooong Title",
         },
         "name": "loooooooooooooooooooong-title",
         "route": "/docs/advanced/more/loooooooooooooooooooong-title",

diff --git a/packages/nextra/__test__/__snapshots__/page-map.test.ts.snap b/packages/nextra/__test__/__snapshots__/page-map.test.ts.snap
@@ -196,7 +196,7 @@ exports[`Page Process > pageMap en-US 1`] = `
               },
               "title": "Change Log",
             },
-            "code-block-without-language": "code-block-without-language",
+            "code-block-without-language": "Code Block without Language",
             "conditional-fetching": "Conditional Data Fetching",
             "data-fetching": "Data Fetching",
             "error-handling": {
@@ -289,7 +289,7 @@ exports[`Page Process > pageMap en-US 1`] = `
                 },
                 {
                   "data": {
-                    "loooooooooooooooooooong-title": "loooooooooooooooooooong-title",
+                    "loooooooooooooooooooong-title": "Loooooooooooooooooooong Title",
                   },
                   "kind": "Meta",
                   "locale": "en-US",
@@ -695,7 +695,7 @@ exports[`Page Process > pageMap zh-CN 1`] = `
                 },
                 {
                   "data": {
-                    "loooooooooooooooooooong-title": "loooooooooooooooooooong-title",
+                    "loooooooooooooooooooong-title": "Loooooooooooooooooooong Title",
                   },
                   "kind": "Meta",
                   "locale": "en-US",

diff --git a/packages/nextra/package.json b/packages/nextra/package.json
@@ -86,7 +86,8 @@
     "remark-gfm": "^3.0.1",
     "remark-reading-time": "^2.0.1",
     "shiki": "0.10.1",
-    "slash": "^3.0.0"
+    "slash": "^3.0.0",
+    "title": "^3.5.3"
   },
   "peerDependencies": {
     "next": ">=9.5.3",

diff --git a/packages/nextra/src/env.d.ts b/packages/nextra/src/env.d.ts
@@ -5,3 +5,12 @@ declare module globalThis {
     route: string
   }
 }
+
+declare module 'title' {
+  export default function title(
+    title: string,
+    special?: {
+      special: string[]
+    }
+  )
+}
diff --git a/packages/nextra/src/plugin.ts b/packages/nextra/src/plugin.ts
@@ -16,6 +16,7 @@ import slash from 'slash'
 import grayMatter from 'gray-matter'
 import { findPagesDir } from 'next/dist/lib/find-pages-dir.js'
 import { Compiler } from 'webpack'
+import title from 'title'
 
 import { restoreCache } from './content-dump'
 import { CWD, MARKDOWN_EXTENSION_REGEX, META_FILENAME } from './constants'
@@ -103,7 +104,10 @@ export async function collectFiles(
     )
     const defaultMeta: [string, string][] = mdxPages
       .filter(item => item.locale === locale)
-      .map(item => [item.name, item.frontMatter?.title || item.name])
+      .map(item => [
+        item.name,
+        item.frontMatter?.title || title(item.name.replace(/[-_]/g, ' '))
+      ])
     const metaFilename = locale
       ? META_FILENAME.replace('.', `.${locale}.`)
       : META_FILENAME

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml