@waveso/docs 0.2.0 → 0.3.0

package/dist/types.d.ts

@@ -1,5 +1,5 @@
-import { StandardSchemaV1 } from "@standard-schema/spec";
 import { Root } from "hast";
+import { StandardSchemaV1 } from "@standard-schema/spec";
 //#region src/types.d.ts
 /**
  * The frontmatter fields the package itself understands.
@@ -133,7 +133,16 @@ interface DocsMeta {
 interface TocEntry {
   id: string;
   text: string;
-  /** Heading level, 2–6. `h1` is the page title and is never in the TOC. */
+  /**
+   * Heading level. `h1` is the page title and is never in the TOC.
+   *
+   * In practice **2 or 3**: the capture stops at `h3`, measured on a synthetic
+   * API reference where taking `h2`–`h6` gave 104 entries against 32. Deeper
+   * headings keep their ids and permalinks, so they stay deep-linkable and
+   * still open their own sections in search — only the rail entry is dropped.
+   * `number` rather than `2 | 3` because `rehypePlugins` is the escape hatch
+   * for putting them back, and a literal union would make that a type error.
+   */
   depth: number;
   children: TocEntry[];
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@waveso/docs",
-  "version": "0.2.0",
-  "description": "Markdown documentation for Next.js — parsed to hast in Node at build time, rendered as your own React components, zero parser bytes in the browser",
+  "version": "0.3.0",
+  "description": "Zero parser bytes in the browser: markdown docs for Next.js, built to hast in Node and rendered as your components",
   "type": "module",
   "sideEffects": [
     "*.css"
@@ -9,15 +9,11 @@
   "license": "MIT",
   "author": "Wave (https://github.com/wavedotso)",
   "keywords": [
+    "nextjs",
     "documentation",
-    "docs",
     "markdown",
-    "remark",
-    "rehype",
-    "shiki",
-    "nextjs",
     "react-server-components",
-    "static-site"
+    "shiki"
   ],
   "repository": {
     "type": "git",
@@ -35,6 +31,10 @@
       "types": "./dist/types.d.ts",
       "default": "./dist/types.js"
     },
+    "./errors": {
+      "types": "./dist/errors.d.ts",
+      "default": "./dist/errors.js"
+    },
     "./frontmatter": {
       "types": "./dist/frontmatter.d.ts",
       "default": "./dist/frontmatter.js"
@@ -59,22 +59,46 @@
       "browser": null,
       "default": "./dist/search-index.js"
     },
-    "./search-options": {
-      "types": "./dist/search-options.d.ts",
-      "default": "./dist/search-options.js"
-    },
-    "./markdown-links": {
-      "types": "./dist/plugins/remark-doc-links.d.ts",
-      "default": "./dist/plugins/remark-doc-links.js"
-    },
     "./next": {
       "types": "./dist/next.d.ts",
       "browser": null,
       "default": "./dist/next.js"
     },
-    "./react/*": {
-      "types": "./dist/react/*.d.ts",
-      "default": "./dist/react/*.js"
+    "./react/callout": {
+      "types": "./dist/react/callout.d.ts",
+      "default": "./dist/react/callout.js"
+    },
+    "./react/doc-content": {
+      "types": "./dist/react/doc-content.d.ts",
+      "default": "./dist/react/doc-content.js"
+    },
+    "./react/markdown-components": {
+      "types": "./dist/react/markdown-components.d.ts",
+      "default": "./dist/react/markdown-components.js"
+    },
+    "./react/next-search": {
+      "types": "./dist/react/next-search.d.ts",
+      "default": "./dist/react/next-search.js"
+    },
+    "./react/search-dialog": {
+      "types": "./dist/react/search-dialog.d.ts",
+      "default": "./dist/react/search-dialog.js"
+    },
+    "./react/sidebar": {
+      "types": "./dist/react/sidebar.d.ts",
+      "default": "./dist/react/sidebar.js"
+    },
+    "./react/skip-link": {
+      "types": "./dist/react/skip-link.d.ts",
+      "default": "./dist/react/skip-link.js"
+    },
+    "./react/toc": {
+      "types": "./dist/react/toc.d.ts",
+      "default": "./dist/react/toc.js"
+    },
+    "./react/youtube": {
+      "types": "./dist/react/youtube.d.ts",
+      "default": "./dist/react/youtube.js"
     }
   },
   "files": [
@@ -95,7 +119,6 @@
     "@standard-schema/spec": "^1.1.0",
     "@types/hast": "^3.0.5",
     "@types/mdast": "^4.0.4",
-    "gray-matter": "^4.0.3",
     "hast-util-to-jsx-runtime": "^2.3.6",
     "hast-util-to-string": "^3.0.1",
     "minisearch": "^7.2.0",
@@ -109,6 +132,7 @@
     "unified": "^11.0.5",
     "unist-util-visit": "^5.1.0",
     "vfile": "^6.0.3",
+    "vfile-matter": "^5.0.1",
     "zod": "^4.4.3"
   },
   "peerDependencies": {
@@ -131,15 +155,19 @@
     "@types/node": "^24.0.0",
     "@types/react": "^19.2.18",
     "@types/react-dom": "^19.2.4",
+    "@vitest/browser": "4.1.10",
+    "@vitest/browser-playwright": "^4.1.10",
+    "hast-util-to-html": "^9.0.5",
     "image-size": "^2.0.2",
     "jsdom": "^30.0.1",
     "next": "^16.3.0",
+    "playwright": "^1.62.1",
     "publint": "^0.3.23",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
+    "rolldown": "^1.2.4",
     "tsdown": "^0.22.14",
     "typescript": "^5.9.3",
-    "unrun": "^0.3.1",
     "vitest": "^4.1.10"
   },
   "devEngines": {
@@ -156,12 +184,19 @@
     "lint": "biome check",
     "lint:fix": "biome check --write",
     "format": "biome format --write",
-    "test": "vitest run",
+    "test": "vitest run --project node --project dom",
     "test:watch": "vitest",
     "check:package": "publint && attw --pack . --ignore-rules no-resolution cjs-resolves-to-esm",
+    "check:readme": "node scripts/check-readme.ts",
     "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
     "changeset": "changeset",
     "version": "changeset version",
-    "release": "pnpm run build && changeset publish"
+    "release": "pnpm run build && changeset publish",
+    "test:browser": "vitest run --project browser",
+    "test:smoke": "node smoke/check.ts",
+    "size": "node scripts/size.ts",
+    "build:site": "next build site",
+    "dev:site": "next dev site",
+    "shoot": "node scripts/shoot.ts"
   }
 }