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

package/dist/cli/index.mjs

@@ -587,7 +587,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.2",
   "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"