copy as markdown , /{endpoint}.md , open in chat platform

.gitignore

@@ -19,6 +19,7 @@ public/_pagefind/
 # misc
 .DS_Store
 *.pem
+*.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*

archive/README.md

@@ -0,0 +1,45 @@
+# Archived templates
+
+The six themes here — `aurora`, `base`, `cedar`, `fern`, `galley`, `mono` —
+are the pre-0.4.0 template set, kept as a historical reference. They were
+archived in `8245b0a`. The templates the CLI actually scaffolds from live in
+`../templates` (`canopy`, `galley`, `shadcn`).
+
+## These do not build as-is
+
+Each of the six depends on `@inkform/framework: ^0.3.0`. On a 0.x version a
+caret range cannot cross the minor, so `^0.3.0` resolves to the published
+`0.3.0` — while the source in these directories was written against the
+newer API that shipped in `0.4.0`. A standalone `npm install && npm run
+build` in any of them fails at module resolution:
+
+    Module not found: Can't resolve '@inkform/framework/ai'
+    Module not found: Can't resolve '@inkform/framework/openapi-render'
+    Module not found: Can't resolve '@inkform/framework/openapi-engine/nav'
+    Module not found: Can't resolve '@inkform/framework/openapi-engine/parse'
+
+`tsc --noEmit` fails for the same reason, plus two API-shape mismatches: the
+templates pass a `contentType` prop to `DocsShell` and read `apiReference`
+off `DocsTab`, neither of which exists in 0.3.0.
+
+This is expected for archived code and is **not** a regression. It is
+recorded here so the next person to open this directory doesn't spend time
+diagnosing it, and so a current-looking dependency version isn't mistaken
+for a maintained template.
+
+Reviving one of these means re-pointing it at `@inkform/framework: ^0.4.0`
+and reconciling the template source with the 0.4.0 API — see
+[`../MIGRATION.md`](../MIGRATION.md) and the 0.4.0 entry in
+[`../CHANGELOG.md`](../CHANGELOG.md).
+
+## Why dependency versions here still get bumped
+
+`archive/templates/*` is outside the root `package.json`'s `workspaces`
+array, so nothing here is installed, typechecked, or built by `npm ci` or by
+CI. But Dependabot reads every `package.json` in the repo regardless, so
+these six manifests still raise alerts and still need patching — as of the
+Next.js 16.2.12 bump they accounted for 54 of the repo's 60 open alerts.
+
+Bumping a version string here is therefore an alert-hygiene change with no
+effect on any build. It does not imply the template was retested; the
+breakage described above applies before and after.

archive/templates/aurora/package.json

@@ -14,7 +14,7 @@
   "dependencies": {
     "@inkform/framework": "^0.3.0",
     "lucide-react": "^0.483.0",
-    "next": "16.2.10",
+    "next": "16.2.12",
     "react": "19.2.1",
     "react-dom": "19.2.1"
   },

archive/templates/base/package.json

@@ -14,7 +14,7 @@
   "dependencies": {
     "@inkform/framework": "^0.3.0",
     "lucide-react": "^0.483.0",
-    "next": "16.2.10",
+    "next": "16.2.12",
     "react": "19.2.1",
     "react-dom": "19.2.1"
   },

archive/templates/cedar/package.json

@@ -14,7 +14,7 @@
   "dependencies": {
     "@inkform/framework": "^0.3.0",
     "lucide-react": "^0.483.0",
-    "next": "16.2.10",
+    "next": "16.2.12",
     "react": "19.2.1",
     "react-dom": "19.2.1"
   },

archive/templates/fern/package.json

@@ -14,7 +14,7 @@
   "dependencies": {
     "@inkform/framework": "^0.3.0",
     "lucide-react": "^0.483.0",
-    "next": "16.2.10",
+    "next": "16.2.12",
     "react": "19.2.1",
     "react-dom": "19.2.1"
   },

archive/templates/galley/package.json

@@ -14,7 +14,7 @@
   "dependencies": {
     "@inkform/framework": "^0.3.0",
     "lucide-react": "^0.483.0",
-    "next": "16.2.10",
+    "next": "16.2.12",
     "react": "19.2.1",
     "react-dom": "19.2.1"
   },

archive/templates/mono/package.json

@@ -14,7 +14,7 @@
   "dependencies": {
     "@inkform/framework": "^0.3.0",
     "lucide-react": "^0.483.0",
-    "next": "16.2.10",
+    "next": "16.2.12",
     "react": "19.2.1",
     "react-dom": "19.2.1"
   },

examples/inkform-docs/app/[[...slug]]/page.tsx

@@ -1,8 +1,9 @@
 import { notFound } from 'next/navigation';
 import { Mdx } from '@inkform/framework/mdx';
 import { DocsShell, TocList, Pagination } from '@inkform/framework/docs-shell';
+import { PageActions } from '@inkform/framework/page-actions';
 import { docNeighbours } from '@inkform/framework';
-import { loadDocsConfig, extractHeadings } from '@inkform/framework/content';
+import { loadDocsConfig, extractHeadings, stripLeadingH1 } from '@inkform/framework/content';
 import { siteMdxComponents } from '@/mdx-components';
 import { buildTopBar } from '@/components/top-bar';
 import { CollapsibleSidebar } from '@/components/collapsible-sidebar';
@@ -57,7 +58,11 @@ export default async function Page({ params }: { params: Promise<{ slug?: string
       toc={headings.length > 0 ? <TocList headings={headings} /> : undefined}
       hideToc={headings.length === 0}
     >
-      <Mdx source={page.content} components={siteMdxComponents} />
+      <PageActions
+        title={ref.title}
+        markdownUrl={ref.slug === '' ? '/index.md' : `/${ref.slug}.md`}
+      />
+      <Mdx source={stripLeadingH1(page.content)} components={siteMdxComponents} />
       <Pagination
         prev={prev ? { title: prev.title, href: '/' + prev.slug } : null}
         next={next ? { title: next.title, href: '/' + next.slug } : null}

examples/inkform-docs/app/markdown/[[...slug]]/route.ts

@@ -0,0 +1,16 @@
+import { createMarkdownHandler } from '@inkform/framework/markdown';
+import { apiBasePath, loadDocsConfig } from '@/lib/route';
+
+export const runtime = 'nodejs';
+
+/**
+ * GET <slug>.md — any page as Markdown, served at the page's own URL plus a
+ * `.md` extension (e.g. /getting-started/quickstart.md). Index = /index.md.
+ * API operations resolve as /<apiBase>/operations/<operationId>.md; blog and
+ * changelog entries as /blog/<slug>.md and /changelog/<slug>.md. Unknown
+ * pages 404.
+ */
+const config = loadDocsConfig();
+const apiBase = config && apiBasePath(config);
+
+export const GET = createMarkdownHandler({ apiBasePath: apiBase ?? undefined });

examples/inkform-docs/proxy.ts

@@ -4,6 +4,16 @@ import slugHistory from './content/docs/slug-history.json';
 
 /** Docs are served at the root, so slug-history redirects use the '/' base. */
 export function proxy(req: NextRequest) {
+  // Any page is also reachable as Markdown by appending `.md` to its own URL
+  // (e.g. /quickstart.md). Route those to the internal markdown handler; the
+  // `NextResponse.rewrite` keeps the `.md` URL in the address bar while the
+  // response comes from app/markdown/[[...slug]]/route.ts.
+  const { pathname } = req.nextUrl;
+  if (pathname.endsWith('.md') && pathname !== '/markdown' && !pathname.startsWith('/markdown/')) {
+    const slug = pathname.slice(1, -3);
+    return NextResponse.rewrite(new URL(`/markdown/${slug}`, req.url));
+  }
+
   const target = resolveSlugRedirect(
     req.nextUrl.pathname,
     slugHistory as Record<string, string>,

examples/markdown-docs/app/[[...slug]]/page.tsx

@@ -1,8 +1,9 @@
 import { notFound } from 'next/navigation';
 import { Mdx } from '@inkform/framework/mdx';
 import { DocsShell, TocList, Pagination } from '@inkform/framework/docs-shell';
+import { PageActions } from '@inkform/framework/page-actions';
 import { docNeighbours } from '@inkform/framework';
-import { loadDocsConfig, extractHeadings } from '@inkform/framework/content';
+import { loadDocsConfig, extractHeadings, stripLeadingH1 } from '@inkform/framework/content';
 import { siteMdxComponents } from '@/mdx-components';
 import { buildTopBar } from '@/components/top-bar';
 import { CollapsibleSidebar } from '@/components/collapsible-sidebar';
@@ -57,7 +58,11 @@ export default async function Page({ params }: { params: Promise<{ slug?: string
       toc={headings.length > 0 ? <TocList headings={headings} /> : undefined}
       hideToc={headings.length === 0}
     >
-      <Mdx source={page.content} components={siteMdxComponents} />
+      <PageActions
+        title={ref.title}
+        markdownUrl={ref.slug === '' ? '/index.md' : `/${ref.slug}.md`}
+      />
+      <Mdx source={stripLeadingH1(page.content)} components={siteMdxComponents} />
       <Pagination
         prev={prev ? { title: prev.title, href: '/' + prev.slug } : null}
         next={next ? { title: next.title, href: '/' + next.slug } : null}

examples/markdown-docs/app/markdown/[[...slug]]/route.ts

@@ -0,0 +1,16 @@
+import { createMarkdownHandler } from '@inkform/framework/markdown';
+import { apiBasePath, loadDocsConfig } from '@/lib/route';
+
+export const runtime = 'nodejs';
+
+/**
+ * GET <slug>.md — any page as Markdown, served at the page's own URL plus a
+ * `.md` extension (e.g. /quickstart.md, /concepts/pagination.md). Index =
+ * /index.md. API operations resolve as
+ * /<apiBase>/operations/<operationId>.md; blog and changelog entries as
+ * /blog/<slug>.md and /changelog/<slug>.md. Unknown pages 404.
+ */
+const config = loadDocsConfig();
+const apiBase = config && apiBasePath(config);
+
+export const GET = createMarkdownHandler({ apiBasePath: apiBase ?? undefined });

examples/markdown-docs/proxy.ts

@@ -4,6 +4,16 @@ import slugHistory from './content/docs/slug-history.json';
 
 /** Docs are served at the root, so slug-history redirects use the '/' base. */
 export function proxy(req: NextRequest) {
+  // Any page is also reachable as Markdown by appending `.md` to its own URL
+  // (e.g. /quickstart.md). Route those to the internal markdown handler; the
+  // `NextResponse.rewrite` keeps the `.md` URL in the address bar while the
+  // response comes from app/markdown/[[...slug]]/route.ts.
+  const { pathname } = req.nextUrl;
+  if (pathname.endsWith('.md') && pathname !== '/markdown' && !pathname.startsWith('/markdown/')) {
+    const slug = pathname.slice(1, -3);
+    return NextResponse.rewrite(new URL(`/markdown/${slug}`, req.url));
+  }
+
   const target = resolveSlugRedirect(
     req.nextUrl.pathname,
     slugHistory as Record<string, string>,

examples/pokeapi-docs/app/[[...slug]]/page.tsx

@@ -1,8 +1,9 @@
 import { notFound } from 'next/navigation';
 import { Mdx } from '@inkform/framework/mdx';
 import { DocsShell, TocList, Pagination } from '@inkform/framework/docs-shell';
+import { PageActions } from '@inkform/framework/page-actions';
 import { docNeighbours } from '@inkform/framework';
-import { loadDocsConfig, extractHeadings } from '@inkform/framework/content';
+import { loadDocsConfig, extractHeadings, stripLeadingH1 } from '@inkform/framework/content';
 import { siteMdxComponents } from '@/mdx-components';
 import { buildTopBar } from '@/components/top-bar';
 import { CollapsibleSidebar } from '@/components/collapsible-sidebar';
@@ -57,7 +58,11 @@ export default async function Page({ params }: { params: Promise<{ slug?: string
       toc={headings.length > 0 ? <TocList headings={headings} /> : undefined}
       hideToc={headings.length === 0}
     >
-      <Mdx source={page.content} components={siteMdxComponents} />
+      <PageActions
+        title={ref.title}
+        markdownUrl={ref.slug === '' ? '/index.md' : `/${ref.slug}.md`}
+      />
+      <Mdx source={stripLeadingH1(page.content)} components={siteMdxComponents} />
       <Pagination
         prev={prev ? { title: prev.title, href: '/' + prev.slug } : null}
         next={next ? { title: next.title, href: '/' + next.slug } : null}

examples/pokeapi-docs/app/markdown/[[...slug]]/route.ts

@@ -0,0 +1,16 @@
+import { createMarkdownHandler } from '@inkform/framework/markdown';
+import { apiBasePath, loadDocsConfig } from '@/lib/route';
+
+export const runtime = 'nodejs';
+
+/**
+ * GET <slug>.md — any page as Markdown, served at the page's own URL plus a
+ * `.md` extension (e.g. /quickstart.md, /concepts/pagination.md). Index =
+ * /index.md. API operations resolve as
+ * /<apiBase>/operations/<operationId>.md; blog and changelog entries as
+ * /blog/<slug>.md and /changelog/<slug>.md. Unknown pages 404.
+ */
+const config = loadDocsConfig();
+const apiBase = config && apiBasePath(config);
+
+export const GET = createMarkdownHandler({ apiBasePath: apiBase ?? undefined });

examples/pokeapi-docs/proxy.ts

@@ -4,6 +4,16 @@ import slugHistory from './content/docs/slug-history.json';
 
 /** Docs are served at the root, so slug-history redirects use the '/' base. */
 export function proxy(req: NextRequest) {
+  // Any page is also reachable as Markdown by appending `.md` to its own URL
+  // (e.g. /quickstart.md). Route those to the internal markdown handler; the
+  // `NextResponse.rewrite` keeps the `.md` URL in the address bar while the
+  // response comes from app/markdown/[[...slug]]/route.ts.
+  const { pathname } = req.nextUrl;
+  if (pathname.endsWith('.md') && pathname !== '/markdown' && !pathname.startsWith('/markdown/')) {
+    const slug = pathname.slice(1, -3);
+    return NextResponse.rewrite(new URL(`/markdown/${slug}`, req.url));
+  }
+
   const target = resolveSlugRedirect(
     req.nextUrl.pathname,
     slugHistory as Record<string, string>,

package.json

@@ -27,7 +27,7 @@
     "prettier": "^3.5.1"
   },
   "overrides": {
-    "js-yaml": "^3.15.0",
+    "js-yaml": "^3.15.1",
     "next": {
       "postcss": "8.5.23",
       "sharp": "0.35.3"

packages/framework/package.json

@@ -45,13 +45,15 @@
     "./ai": "./src/ai/index.ts",
     "./llms-txt": "./src/llms-txt.ts",
     "./mdx": "./src/mdx.tsx",
+    "./markdown": "./src/markdown.ts",
     "./components": "./src/components.tsx",
     "./docs-shell": "./src/docs-shell.tsx",
     "./scalar-theme": "./src/scalar-theme.ts",
     "./search-dialog": "./src/search-dialog.tsx",
     "./pagefind-highlight": "./src/pagefind-highlight-mount.tsx",
     "./ask-ai": "./src/ask-ai.tsx",
     "./ai-tool-menu": "./src/ai-tool-menu.tsx",
+    "./page-actions": "./src/page-actions.tsx",
     "./theme-toggle": "./src/theme-toggle.tsx",
     "./subscribe-form": "./src/subscribe-form.tsx",
     "./analytics-script": "./src/analytics-script.tsx",