@primer/doctocat-nextjs 0.9.1 → 0.10.0-rc.0e425b1

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @primer/doctocat-nextjs
 
+## 0.10.0
+
+### Minor Changes
+
+- [#99](https://github.com/primer/doctocat-nextjs/pull/99) [`1b72c82`](https://github.com/primer/doctocat-nextjs/commit/1b72c8203115a0e1c7bb511b7abe257cc33ab558) Thanks [@rezrah](https://github.com/rezrah)! - Updated dependencies to latest versions.
+  - `@primer/react` 38.3.0 → 38.18.0
+  - `@primer/octicons-react` 19.15.1 → 19.23.1
+  - `@next/mdx` and `next` 16.1.6 → 16.2.2
+  - `framer-motion` 12.23.24 → 12.38.0
+  - Replaced `Hero.Image` with standalone `Image` from `@primer/react-brand` for compatibility with 0.65.1
+
+- [#98](https://github.com/primer/doctocat-nextjs/pull/98) [`a4e4e89`](https://github.com/primer/doctocat-nextjs/commit/a4e4e89d6935250ab6f8ac84d0d2dc8e9f3b5654) Thanks [@rezrah](https://github.com/rezrah)! - Added support for generating [llms.txt](https://llmstxt.org/) at build time. This file will make your site's content easily discoverable by Agentic AI tools like GitHub Copilot.
+
+  To enable this feature, create `app/llms.txt/route.ts`:
+
+  ```ts
+  import {generateLLMsTxt} from '@primer/doctocat-nextjs/llms'
+
+  export const dynamic = 'force-static'
+
+  export async function GET() {
+    const content = await generateLLMsTxt()
+
+    return new Response(content, {
+      headers: {'Content-Type': 'text/plain; charset=utf-8'},
+    })
+  }
+  ```
+
+  Important: Ensure that `title`, `description` and `keywords` fields are populated in your content's frontmatter.
+
 ## 0.9.1
 
 ### Patch Changes

package/components/layout/root-layout/Theme.tsx

@@ -13,8 +13,8 @@ import {
   ButtonGroup,
   ThemeProvider as BrandThemeProvider,
   Button,
-  Hero,
   Heading,
+  Image,
   Stack,
   Text,
 } from '@primer/react-brand'
@@ -201,7 +201,7 @@ export function Theme({pageMap, children}: ThemeProps) {
                                 )}
                                 {activeMetadata.image && (
                                   <div className={styles.HeroImageWrapper}>
-                                    <Hero.Image src={activeMetadata.image} alt={activeMetadata['image-alt']} />
+                                    <Image src={activeMetadata.image} alt={activeMetadata['image-alt']} />
                                   </div>
                                 )}
                                 {activeMetadata['action-1-text'] && (

package/llms.ts

@@ -0,0 +1,70 @@
+import {getPageMap} from 'nextra/page-map'
+import type {PageMapItem, MdxFile} from 'nextra'
+import {hasChildren} from './helpers/hasChildren'
+
+function isMdxFile(item: PageMapItem): item is MdxFile {
+  return 'route' in item && 'name' in item && !('children' in item) && !('data' in item)
+}
+
+function getTitle(item: MdxFile): string {
+  const title = (item.frontMatter?.title as string) || item.name
+  const tabLabel = item.frontMatter?.['tab-label'] as string | undefined
+  return tabLabel ? `${title} - ${tabLabel}` : title
+}
+
+function getDescription(item: MdxFile): string | undefined {
+  return item.frontMatter?.description as string | undefined
+}
+
+function getKeywords(item: MdxFile): string[] | undefined {
+  const keywords = item.frontMatter?.keywords
+  return Array.isArray(keywords) && keywords.length > 0 ? keywords : undefined
+}
+
+function getPages(items: PageMapItem[]): MdxFile[] {
+  const pages: MdxFile[] = []
+  for (const item of items) {
+    if (isMdxFile(item)) {
+      pages.push(item)
+    } else if (hasChildren(item)) {
+      pages.push(...getPages(item.children))
+    }
+  }
+  return pages
+}
+
+export async function generateLLMsTxt(): Promise<string> {
+  const pageMap = await getPageMap()
+  const pages = getPages(pageMap)
+  const basePath = process.env.NEXT_PUBLIC_DOCTOCAT_BASE_PATH || ''
+
+  // use homepage to auto-infer site title and descriptions. most users should have filled these out.
+  const homepage = pages.find(page => page.route === '/')
+  const title = (homepage?.frontMatter?.title as string) || process.env.NEXT_PUBLIC_SITE_TITLE || 'Documentation'
+  const description = (homepage?.frontMatter?.description as string) || undefined
+
+  const lines: string[] = [`# ${title}`, '']
+
+  if (description) {
+    lines.push(`> ${description}`, '')
+  }
+
+  lines.push('## Pages', '')
+
+  // start adding all sub pages
+  for (const page of pages) {
+    const pageTitle = getTitle(page)
+    const pageDesc = getDescription(page)
+    const keywords = getKeywords(page)
+    const route = `${basePath}${page.route || '/'}`
+
+    let entry = `- [${pageTitle}](${route})`
+    if (pageDesc) entry += `: ${pageDesc}`
+    if (keywords) entry += ` (${keywords.join(', ')})`
+
+    lines.push(entry)
+  }
+
+  lines.push('')
+  return lines.join('\n')
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@primer/doctocat-nextjs",
-  "version": "0.9.1",
+  "version": "0.10.0-rc.0e425b1",
   "description": "A Next.js theme for building Primer documentation sites",
   "main": "index.js",
   "type": "module",
@@ -25,33 +25,33 @@
     "react-dom": ">=18.0.0 <20.0.0"
   },
   "dependencies": {
-    "@next/mdx": "16.1.6",
-    "@primer/octicons-react": "19.15.1",
-    "@primer/react": "^38.3.0",
+    "@next/mdx": "16.2.2",
+    "@primer/octicons-react": "19.23.1",
+    "@primer/react": "^38.18.0",
     "@types/lodash.debounce": "^4.0.9",
-    "framer-motion": "12.23.24",
+    "framer-motion": "12.38.0",
     "lodash.debounce": "^4.0.8",
     "nextra": "4.6.1",
-    "react-focus-on": "^3.10.0",
-    "react-is": "^19.2.0",
+    "react-focus-on": "^3.10.2",
+    "react-is": "^19.2.4",
     "react-live": "^4.1.8"
   },
   "devDependencies": {
     "@github/prettier-config": "^0.0.6",
-    "@testing-library/dom": "^10.4.0",
-    "@testing-library/jest-dom": "^6.6.3",
-    "@testing-library/react": "^16.1.0",
-    "@testing-library/user-event": "^14.5.2",
-    "@types/node": "^20.19.0",
-    "@types/react": "^19.2.7",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/node": "^24.12.0",
+    "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^4.3.3",
-    "@vitest/coverage-v8": "^3.2.4",
-    "@vitest/ui": "^3.2.4",
+    "@vitest/coverage-v8": "^4.1.2",
+    "@vitest/ui": "^4.1.2",
     "clsx": "2.1.1",
-    "jsdom": "^26.0.1",
-    "next": "16.1.6",
+    "jsdom": "^29.0.1",
+    "next": "16.2.2",
     "styled-components": "5.3.11",
-    "vitest": "^3.2.4"
+    "vitest": "^4.1.2"
   }
 }