@farming-labs/next 0.2.49 → 0.2.52

package/README.md

@@ -0,0 +1,88 @@
+# @farming-labs/next
+
+The Next.js App Router adapter for
+[`@farming-labs/docs`](https://www.npmjs.com/package/@farming-labs/docs).
+
+It connects the shared docs configuration and theme to Next.js, compiles Markdown and MDX,
+generates the standard docs routes, and provides Next-native runtime helpers for documentation
+APIs, API references, MCP, and changelogs.
+
+## What this package does
+
+- Wraps `next.config.ts` with the Farming Labs MDX and routing integration
+- Generates missing docs layouts, API routes, MCP routes, and enabled feature routes
+- Adds machine-readable Markdown, agent discovery, sitemap, and `llms.txt` rewrites
+- Provides App Router layout, metadata, API-reference, and changelog helpers
+- Preserves user-authored files and existing Next.js configuration
+
+The shared config and CLI live in `@farming-labs/docs`. React UI, MDX components, providers, and
+theme CSS live in `@farming-labs/theme`.
+
+## Install
+
+The CLI can add docs to an existing Next.js project:
+
+```bash
+npx @farming-labs/docs@latest init
+```
+
+For manual installation:
+
+```bash
+npm install @farming-labs/docs @farming-labs/next @farming-labs/theme
+```
+
+## Minimal setup
+
+Create `docs.config.ts` with `defineDocs()`, then wrap the Next.js config:
+
+```ts
+// next.config.ts
+import { withDocs } from "@farming-labs/next/config";
+
+export default withDocs();
+```
+
+Existing Next.js configuration can be passed directly:
+
+```ts
+export default withDocs({
+  reactStrictMode: true,
+});
+```
+
+Import the selected theme in your global stylesheet:
+
+```css
+@import "tailwindcss";
+@import "@farming-labs/theme/default/css";
+```
+
+Write documentation pages under `app/docs/` or `src/app/docs/`. The CLI also adds the root
+`RootProvider`, generated docs layout, and server routes needed for a complete setup.
+
+## Main entrypoints
+
+| Entrypoint | Purpose |
+| --- | --- |
+| `@farming-labs/next/config` | `withDocs()` Next.js configuration wrapper |
+| `@farming-labs/next/layout` | App Router docs layout and metadata helpers |
+| `@farming-labs/next/api` | Docs API and MCP route handlers |
+| `@farming-labs/next/api-reference` | Generated API-reference routes and pages |
+| `@farming-labs/next/changelog` | Generated changelog page helpers |
+
+## Requirements
+
+- Next.js 16 or newer
+- React and React DOM 19.2 or newer
+- `@farming-labs/docs` and `@farming-labs/theme`
+
+## Learn more
+
+- [Documentation](https://docs.farming-labs.dev/docs)
+- [Next.js example](https://github.com/farming-labs/docs/tree/main/examples/next)
+- [GitHub repository](https://github.com/farming-labs/docs)
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/next",
-  "version": "0.2.49",
+  "version": "0.2.52",
   "description": "Next.js adapter for @farming-labs/docs — MDX config wrapper",
   "keywords": [
     "docs",
@@ -106,8 +106,8 @@
     "tsdown": "^0.20.3",
     "typescript": "^5.9.3",
     "vitest": "^4.1.8",
-    "@farming-labs/theme": "0.2.49",
-    "@farming-labs/docs": "0.2.49"
+    "@farming-labs/docs": "0.2.52",
+    "@farming-labs/theme": "0.2.52"
   },
   "peerDependencies": {
     "@farming-labs/docs": ">=0.0.1",