@farming-labs/docs 0.0.2-beta.27 → 0.0.2-beta.29

package/dist/cli/index.mjs

@@ -363,7 +363,8 @@ const config = {
 export default config;
 `;
 }
-function tsconfigTemplate() {
+/** @param useAlias - When false, paths (e.g. @/*) are omitted so no alias is added. */
+function tsconfigTemplate(useAlias = false) {
 	return `\
 {
   "compilerOptions": {
@@ -380,8 +381,7 @@ function tsconfigTemplate() {
     "isolatedModules": true,
     "jsx": "react-jsx",
     "incremental": true,
-    "plugins": [{ "name": "next" }],
-    "paths": { "@/*": ["./*"] }
+    "plugins": [{ "name": "next" }]${useAlias ? ",\n    \"paths\": { \"@/*\": [\"./*\"] }" : ""}
   },
   "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
   "exclude": ["node_modules"]
@@ -1190,11 +1190,12 @@ export default defineDocs({
 `;
 }
 function nuxtDocsServerTemplate(cfg) {
+	const contentDirName = cfg.entry ?? "docs";
 	return `\
 import { createDocsServer } from "@farming-labs/nuxt/server";
-import config from "../../docs.config";
+import config from "${cfg.useAlias ? "~/docs.config" : "../../docs.config"}";
 
-const contentFiles = import.meta.glob("/${cfg.entry ?? "docs"}/**/*.{md,mdx}", {
+const contentFiles = import.meta.glob("/${contentDirName}/**/*.{md,mdx}", {
   query: "?raw",
   import: "default",
   eager: true,
@@ -1479,9 +1480,43 @@ function injectNuxtCssImport(existingContent, theme) {
 
 //#endregion
 //#region src/cli/init.ts
-async function init() {
+const EXAMPLES_REPO = "farming-labs/docs";
+const VALID_TEMPLATES = [
+	"next",
+	"nuxt",
+	"sveltekit",
+	"astro"
+];
+async function init(options = {}) {
 	const cwd = process.cwd();
 	p.intro(pc.bgCyan(pc.black(" @farming-labs/docs ")));
+	if (options.template) {
+		const template = options.template.toLowerCase();
+		if (!VALID_TEMPLATES.includes(template)) {
+			p.log.error(`Invalid ${pc.cyan("--template")}. Use one of: ${VALID_TEMPLATES.map((t) => pc.cyan(t)).join(", ")}`);
+			process.exit(1);
+		}
+		const templateLabel = template === "next" ? "Next.js" : template === "nuxt" ? "Nuxt" : template === "sveltekit" ? "SvelteKit" : "Astro";
+		p.log.step(`Cloning ${pc.cyan(`examples/${template}`)} from ${pc.cyan(EXAMPLES_REPO)}...`);
+		try {
+			exec(`npx degit ${EXAMPLES_REPO}/examples/${template} . --force`, cwd);
+		} catch (err) {
+			p.log.error("Failed to clone the example. Check your connection and that the repo exists.");
+			process.exit(1);
+		}
+		p.log.success(`Cloned ${templateLabel} example. Installing dependencies...`);
+		const pm = detectPackageManager(cwd);
+		try {
+			if (pm === "pnpm") exec("pnpm install", cwd);
+			else if (pm === "yarn") exec("yarn install", cwd);
+			else if (pm === "bun") exec("bun install", cwd);
+			else exec("npm install", cwd);
+		} catch {
+			p.log.warn("Dependency install failed. Run your package manager install command manually.");
+		}
+		p.outro(pc.green(`Done! Run ${pc.cyan(pm === "yarn" ? "yarn dev" : pm === "bun" ? "bun dev" : `${pm} run dev`)} to start the dev server.`));
+		process.exit(0);
+	}
 	let framework = detectFramework(cwd);
 	if (framework) {
 		const frameworkName = framework === "nextjs" ? "Next.js" : framework === "sveltekit" ? "SvelteKit" : framework === "astro" ? "Astro" : "Nuxt";
@@ -1793,7 +1828,7 @@ function scaffoldNextJs(cwd, cfg, globalCssRelPath, write, skipped, written) {
 	} else write(globalCssRelPath, globalCssTemplate(cfg.theme));
 	write(`app/${cfg.entry}/layout.tsx`, docsLayoutTemplate(cfg));
 	write("postcss.config.mjs", postcssConfigTemplate());
-	if (!fileExists(path.join(cwd, "tsconfig.json"))) write("tsconfig.json", tsconfigTemplate());
+	if (!fileExists(path.join(cwd, "tsconfig.json"))) write("tsconfig.json", tsconfigTemplate(cfg.useAlias));
 	write(`app/${cfg.entry}/page.mdx`, welcomePageTemplate(cfg));
 	write(`app/${cfg.entry}/installation/page.mdx`, installationPageTemplate(cfg));
 	write(`app/${cfg.entry}/quickstart/page.mdx`, quickstartPageTemplate(cfg));
@@ -1893,9 +1928,31 @@ function scaffoldNuxt(cwd, cfg, globalCssRelPath, write, skipped, written) {
 
 //#endregion
 //#region src/cli/index.ts
-const command = process.argv.slice(2)[0];
+const args = process.argv.slice(2);
+const command = args[0];
+/** Parse flags like --template next, --theme darksharp, --entry docs */
+function parseFlags(argv) {
+	const flags = {};
+	for (let i = 0; i < argv.length; i++) {
+		const arg = argv[i];
+		if (arg.startsWith("--") && arg.includes("=")) {
+			const [key, value] = arg.slice(2).split("=");
+			flags[key] = value;
+		} else if (arg.startsWith("--") && argv[i + 1] && !argv[i + 1].startsWith("--")) {
+			flags[arg.slice(2)] = argv[i + 1];
+			i++;
+		}
+	}
+	return flags;
+}
 async function main() {
-	if (!command || command === "init") await init();
+	const flags = parseFlags(args);
+	const initOptions = {
+		template: flags.template,
+		theme: flags.theme,
+		entry: flags.entry
+	};
+	if (!command || command === "init") await init(initOptions);
 	else if (command === "--help" || command === "-h") printHelp();
 	else if (command === "--version" || command === "-v") printVersion();
 	else {
@@ -1918,9 +1975,12 @@ ${pc.dim("Commands:")}
 ${pc.dim("Supported frameworks:")}
   Next.js, SvelteKit, Astro, Nuxt
 
-${pc.dim("Options:")}
-  ${pc.cyan("-h, --help")}       Show this help message
-  ${pc.cyan("-v, --version")}    Show version
+${pc.dim("Options for init:")}
+  ${pc.cyan("--template <name>")}  Clone an example (${pc.dim("next")}, ${pc.dim("nuxt")}, ${pc.dim("sveltekit")}, ${pc.dim("astro")}) and get started
+  ${pc.cyan("--theme <name>")}     Skip theme prompt (e.g. ${pc.dim("darksharp")}, ${pc.dim("greentree")})
+  ${pc.cyan("--entry <path>")}     Skip entry path prompt (e.g. ${pc.dim("docs")})
+  ${pc.cyan("-h, --help")}         Show this help message
+  ${pc.cyan("-v, --version")}     Show version
 `);
 }
 function printVersion() {

package/dist/index.d.mts

@@ -431,10 +431,13 @@ interface OpenDocsProvider {
   /** Icon element rendered next to the name */
   icon?: unknown;
   /**
-   * URL template. `{url}` is replaced with the current page URL.
-   * `{mdxUrl}` is replaced with the `.mdx` variant of the page URL.
+   * URL template. Placeholders:
+   * - `{url}` — current page URL (encoded).
+   * - `{mdxUrl}` — page URL with `.mdx` suffix (encoded).
+   * - `{githubUrl}` — GitHub edit URL for the current page (same as "Edit on GitHub"). Requires `github` in config.
    *
    * @example "https://claude.ai/new?q=Read+this+doc:+{url}"
+   * @example "{githubUrl}" — open current page file on GitHub (edit view)
    */
   urlTemplate: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/docs",
-  "version": "0.0.2-beta.27",
+  "version": "0.0.2-beta.29",
   "description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
   "keywords": [
     "docs",