@farming-labs/next 0.0.2-beta.8 → 0.0.2

package/dist/config.mjs

@@ -70,6 +70,16 @@ function readDocsEntry(root) {
 	}
 	return "docs";
 }
+/** Read the OG endpoint from docs.config.ts[x] (returns undefined if not set). */
+function readOgEndpoint(root) {
+	for (const ext of FILE_EXTS) {
+		const configPath = join(root, `docs.config.${ext}`);
+		if (existsSync(configPath)) try {
+			const match = readFileSync(configPath, "utf-8").match(/endpoint\s*:\s*["']([^"']+)["']/);
+			if (match && match[1]) return match[1];
+		} catch {}
+	}
+}
 function withDocs(nextConfig = {}) {
 	const root = process.cwd();
 	if (!hasFile(root, "mdx-components")) writeFileSync(join(root, "mdx-components.tsx"), MDX_COMPONENTS_TEMPLATE);
@@ -84,15 +94,14 @@ function withDocs(nextConfig = {}) {
 		mkdirSync(docsApiRouteDir, { recursive: true });
 		writeFileSync(join(docsApiRouteDir, "route.ts"), DOCS_API_ROUTE_TEMPLATE);
 	}
+	const ogEndpoint = readOgEndpoint(root);
+	const remarkPlugins = ["remark-gfm", "remark-frontmatter"];
+	if (ogEndpoint) remarkPlugins.push(["@farming-labs/next/mdx-plugins/remark-og", { endpoint: ogEndpoint }]);
+	remarkPlugins.push(["remark-mdx-frontmatter", { name: "metadata" }], "@farming-labs/next/mdx-plugins/remark-heading");
 	const withMDX = createMDX({
 		extension: /\.mdx?$/,
 		options: {
-			remarkPlugins: [
-				"remark-gfm",
-				"remark-frontmatter",
-				["remark-mdx-frontmatter", { name: "metadata" }],
-				"@farming-labs/next/mdx-plugins/remark-heading"
-			],
+			remarkPlugins,
 			rehypePlugins: ["@farming-labs/next/mdx-plugins/rehype-toc", ["@farming-labs/next/mdx-plugins/rehype-code", { themes: {
 				dark: "github-dark",
 				light: "github-light"

package/dist/mdx-plugins/remark-og.d.mts

@@ -0,0 +1,19 @@
+//#region src/mdx-plugins/remark-og.d.ts
+/**
+ * Remark plugin that augments frontmatter with Open Graph metadata.
+ *
+ * Runs between remark-frontmatter and remark-mdx-frontmatter.
+ * Reads title/description from the YAML node and appends openGraph + twitter
+ * fields so that remark-mdx-frontmatter exports them as part of `metadata`.
+ */
+interface RemarkOgOptions {
+  endpoint?: string;
+}
+declare function remarkOg(options?: RemarkOgOptions): (tree: {
+  children: Array<{
+    type: string;
+    value: string;
+  }>;
+}) => void;
+//#endregion
+export { remarkOg as default };

package/dist/mdx-plugins/remark-og.mjs

@@ -0,0 +1,25 @@
+//#region src/mdx-plugins/remark-og.ts
+function extractField(yaml, key) {
+	const re = new RegExp(`^${key}:\\s*(?:"([^"]*?)"|'([^']*?)'|(.+?))\\s*$`, "m");
+	const m = yaml.match(re);
+	return m?.[1] ?? m?.[2] ?? m?.[3];
+}
+function remarkOg(options = {}) {
+	const { endpoint = "/api/og" } = options;
+	return (tree) => {
+		const yamlNode = tree.children.find((n) => n.type === "yaml");
+		if (!yamlNode) return;
+		const title = extractField(yamlNode.value, "title");
+		if (!title) return;
+		const description = extractField(yamlNode.value, "description");
+		const params = new URLSearchParams({ title });
+		if (description) params.set("description", description);
+		const ogUrl = `${endpoint}?${params.toString()}`;
+		yamlNode.value += `
+openGraph:
+  images:\n    - url: "${ogUrl}"\n      width: 1200\n      height: 630\ntwitter:\n  card: "summary_large_image"\n  images:\n    - "${ogUrl}"`;
+	};
+}
+
+//#endregion
+export { remarkOg as default };

package/package.json

@@ -1,7 +1,18 @@
 {
   "name": "@farming-labs/next",
-  "version": "0.0.2-beta.8",
+  "version": "0.0.2",
   "description": "Next.js adapter for @farming-labs/docs — MDX config wrapper",
+  "keywords": [
+    "docs",
+    "documentation",
+    "mdx",
+    "next"
+  ],
+  "license": "MIT",
+  "author": "Farming Labs",
+  "files": [
+    "dist"
+  ],
   "type": "module",
   "main": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
@@ -30,19 +41,13 @@
       "types": "./dist/mdx-plugins/rehype-code.d.mts",
       "import": "./dist/mdx-plugins/rehype-code.mjs",
       "default": "./dist/mdx-plugins/rehype-code.mjs"
+    },
+    "./mdx-plugins/remark-og": {
+      "types": "./dist/mdx-plugins/remark-og.d.mts",
+      "import": "./dist/mdx-plugins/remark-og.mjs",
+      "default": "./dist/mdx-plugins/remark-og.mjs"
     }
   },
-  "files": [
-    "dist"
-  ],
-  "keywords": [
-    "docs",
-    "next",
-    "mdx",
-    "documentation"
-  ],
-  "author": "Farming Labs",
-  "license": "MIT",
   "dependencies": {
     "@mdx-js/loader": "^3.1.0",
     "@mdx-js/react": "^3.1.0",