@farming-labs/docs 0.0.2-beta.1 → 0.0.2-beta.3

package/dist/cli/index.mjs

@@ -53,6 +53,24 @@ function readFileSafe(filePath) {
 	if (!fs.existsSync(filePath)) return null;
 	return fs.readFileSync(filePath, "utf-8");
 }
+/** Common locations where global CSS files live in Next.js projects. */
+const GLOBAL_CSS_CANDIDATES = [
+	"app/globals.css",
+	"app/global.css",
+	"src/app/globals.css",
+	"src/app/global.css",
+	"styles/globals.css",
+	"styles/global.css",
+	"src/styles/globals.css",
+	"src/styles/global.css"
+];
+/**
+* Find existing global CSS files in the project.
+* Returns relative paths that exist.
+*/
+function detectGlobalCssFiles(cwd) {
+	return GLOBAL_CSS_CANDIDATES.filter((rel) => fs.existsSync(path.join(cwd, rel)));
+}
 /**
 * Run a shell command synchronously, inheriting stdio.
 */
@@ -151,12 +169,16 @@ function nextConfigMergedTemplate(existingContent) {
 	}
 	return lines.join("\n");
 }
-function rootLayoutTemplate() {
+function rootLayoutTemplate(globalCssRelPath = "app/globals.css") {
+	let cssImport;
+	if (globalCssRelPath.startsWith("app/")) cssImport = "./" + globalCssRelPath.slice(4);
+	else if (globalCssRelPath.startsWith("src/app/")) cssImport = "./" + globalCssRelPath.slice(8);
+	else cssImport = "../" + globalCssRelPath;
 	return `\
 import type { Metadata } from "next";
 import { RootProvider } from "@farming-labs/fumadocs";
 import docsConfig from "@/docs.config";
-import "./global.css";
+import "${cssImport}";
 
 export const metadata: Metadata = {
   title: {
@@ -458,6 +480,40 @@ async function init() {
 		process.exit(0);
 	}
 	const entryPath = entry;
+	const detectedCssFiles = detectGlobalCssFiles(cwd);
+	let globalCssRelPath;
+	if (detectedCssFiles.length === 1) {
+		globalCssRelPath = detectedCssFiles[0];
+		p.log.info(`Found global CSS at ${pc.cyan(globalCssRelPath)}`);
+	} else if (detectedCssFiles.length > 1) {
+		const picked = await p.select({
+			message: "Multiple global CSS files found. Which one should we use?",
+			options: detectedCssFiles.map((f) => ({
+				value: f,
+				label: f
+			}))
+		});
+		if (p.isCancel(picked)) {
+			p.outro(pc.red("Init cancelled."));
+			process.exit(0);
+		}
+		globalCssRelPath = picked;
+	} else {
+		const cssPath = await p.text({
+			message: "Where is your global CSS file?",
+			placeholder: "app/globals.css",
+			defaultValue: "app/globals.css",
+			validate: (value) => {
+				if (!value) return "CSS file path is required";
+				if (!value.endsWith(".css")) return "Path must end with .css";
+			}
+		});
+		if (p.isCancel(cssPath)) {
+			p.outro(pc.red("Init cancelled."));
+			process.exit(0);
+		}
+		globalCssRelPath = cssPath;
+	}
 	const pkgJson = JSON.parse(readFileSafe(path.join(cwd, "package.json")));
 	const cfg = {
 		entry: entryPath,
@@ -482,16 +538,16 @@ async function init() {
 			written.push(configFile + " (updated)");
 		} else skipped.push(configFile + " (already configured)");
 	} else write("next.config.ts", nextConfigTemplate());
-	write("app/layout.tsx", rootLayoutTemplate());
-	const globalCssPath = path.join(cwd, "app/global.css");
-	const existingGlobalCss = readFileSafe(globalCssPath);
+	write("app/layout.tsx", rootLayoutTemplate(globalCssRelPath));
+	const globalCssAbsPath = path.join(cwd, globalCssRelPath);
+	const existingGlobalCss = readFileSafe(globalCssAbsPath);
 	if (existingGlobalCss) {
 		const injected = injectCssImport(existingGlobalCss, theme);
 		if (injected) {
-			writeFileSafe(globalCssPath, injected, true);
-			written.push("app/global.css (updated)");
-		} else skipped.push("app/global.css (already configured)");
-	} else write("app/global.css", globalCssTemplate(theme));
+			writeFileSafe(globalCssAbsPath, injected, true);
+			written.push(globalCssRelPath + " (updated)");
+		} else skipped.push(globalCssRelPath + " (already configured)");
+	} else write(globalCssRelPath, globalCssTemplate(theme));
 	write(`app/${entryPath}/layout.tsx`, docsLayoutTemplate());
 	write("postcss.config.mjs", postcssConfigTemplate());
 	if (!fileExists(path.join(cwd, "tsconfig.json"))) write("tsconfig.json", tsconfigTemplate());
@@ -587,7 +643,7 @@ function printHelp() {
 ${pc.bold("@farming-labs/docs")} — Documentation framework CLI
 
 ${pc.dim("Usage:")}
-  farming-docs ${pc.cyan("<command>")}
+  npx @farming-labs/docs ${pc.cyan("<command>")}
 
 ${pc.dim("Commands:")}
   ${pc.cyan("init")}    Scaffold docs in your project (default)

package/dist/index.d.mts

@@ -405,11 +405,71 @@ interface PageActionsConfig {
    */
   position?: "above-title" | "below-title";
 }
+/**
+ * GitHub repository configuration for "Edit on GitHub" links
+ * and source file references.
+ *
+ * @example
+ * ```ts
+ * // Simple repo (not a monorepo)
+ * github: {
+ *   url: "https://github.com/Kinfe123/my-docs",
+ * }
+ *
+ * // Monorepo — docs site lives in "website/" subdirectory
+ * github: {
+ *   url: "https://github.com/farming-labs/docs",
+ *   directory: "website",
+ *   branch: "main",
+ * }
+ * ```
+ *
+ * Or as a simple string (branch defaults to "main", no directory prefix):
+ * ```ts
+ * github: "https://github.com/Kinfe123/my-docs"
+ * ```
+ */
+interface GithubConfig {
+  /** Repository URL (e.g. "https://github.com/farming-labs/docs") */
+  url: string;
+  /** Branch name. @default "main" */
+  branch?: string;
+  /**
+   * Subdirectory inside the repo where the docs site lives.
+   * Use this for monorepos where the docs app is not at the repo root.
+   *
+   * @example "website" → links point to `website/app/docs/…/page.mdx`
+   */
+  directory?: string;
+}
 interface DocsConfig {
   /** Entry folder for docs (e.g. "docs" → /docs) */
   entry: string;
   /** Theme configuration - single source of truth for UI */
   theme?: DocsTheme;
+  /**
+   * GitHub repository URL or config. Enables "Edit on GitHub" links
+   * on each docs page footer, pointing to the source `.mdx` file.
+   *
+   * @example
+   * ```ts
+   * // Simple — branch defaults to "main"
+   * github: "https://github.com/Kinfe123/my-docs"
+   *
+   * // Monorepo — docs site lives in "website/" subdirectory
+   * github: {
+   *   url: "https://github.com/farming-labs/docs",
+   *   directory: "website",
+   * }
+   *
+   * // Custom branch
+   * github: {
+   *   url: "https://github.com/Kinfe123/my-docs",
+   *   branch: "develop",
+   * }
+   * ```
+   */
+  github?: string | GithubConfig;
   /**
    * Sidebar navigation header.
    * Customise the title shown at the top of the sidebar.
@@ -594,4 +654,4 @@ declare function resolveTitle(pageTitle: string, metadata?: DocsMetadata): strin
  */
 declare function resolveOGImage(page: PageFrontmatter, ogConfig?: OGConfig, baseUrl?: string): string | undefined;
 //#endregion
-export { type BreadcrumbConfig, type CopyMarkdownConfig, type DocsConfig, type DocsMetadata, type DocsNav, type DocsTheme, type FontStyle, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type PageActionsConfig, type PageFrontmatter, type SidebarConfig, type ThemeToggleConfig, type TypographyConfig, type UIConfig, createTheme, deepMerge, defineDocs, extendTheme, resolveOGImage, resolveTitle };
+export { type BreadcrumbConfig, type CopyMarkdownConfig, type DocsConfig, type DocsMetadata, type DocsNav, type DocsTheme, type FontStyle, type GithubConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type PageActionsConfig, type PageFrontmatter, type SidebarConfig, type ThemeToggleConfig, type TypographyConfig, type UIConfig, createTheme, deepMerge, defineDocs, extendTheme, resolveOGImage, resolveTitle };

package/dist/index.mjs

@@ -7,6 +7,7 @@ function defineDocs(config) {
 		entry: config.entry ?? "docs",
 		theme: config.theme,
 		nav: config.nav,
+		github: config.github,
 		themeToggle: config.themeToggle,
 		breadcrumb: config.breadcrumb,
 		sidebar: config.sidebar,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/docs",
-  "version": "0.0.2-beta.1",
+  "version": "0.0.2-beta.3",
   "description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -14,7 +14,7 @@
     }
   },
   "bin": {
-    "farming-docs": "./dist/cli/index.mjs"
+    "docs": "./dist/cli/index.mjs"
   },
   "files": [
     "dist"