@ahmedrowaihi/8n 0.2.1 → 0.3.0

package/dist/index.mjs

@@ -15074,7 +15074,17 @@ const configSchema = objectType({
 		repo: stringType(),
 		branch: stringType().default("main")
 	}).optional(),
-	siteName: stringType().optional()
+	siteName: stringType().optional(),
+	version: stringType().optional(),
+	sections: recordType(unionType([literalType(false), objectType({
+		nav: literalType(false).optional(),
+		search: literalType(false).optional(),
+		sitemap: literalType(false).optional()
+	})])).optional(),
+	nav: objectType({ links: arrayType(objectType({
+		text: stringType(),
+		url: stringType()
+	})).default([]) }).default({})
 });
 
 //#endregion
@@ -36995,13 +37005,13 @@ async function getLatestHash() {
 	if (!res.ok) throw new Error(`GitHub API error: ${res.status}`);
 	return (await res.text()).trim();
 }
-async function prepareSudocs(sudocsDir) {
+async function prepareSudocs(sudocsDir, options) {
 	if (process.env.SUDOCS_LOCAL) return {
 		updated: false,
 		hash: "local",
 		dir: resolve(process.env.SUDOCS_LOCAL)
 	};
-	const latestHash = await getLatestHash();
+	const latestHash = options?.version ?? await getLatestHash();
 	const versionFile = join(sudocsDir, ".8n-version");
 	if ((existsSync(versionFile) ? readFileSync(versionFile, "utf8").trim() : null) === latestHash && existsSync(sudocsDir)) return {
 		updated: false,
@@ -37040,11 +37050,12 @@ function getSudocsBin(sudocsDir, name) {
 function buildEnv(config, contentDir) {
 	return {
 		...process.env,
-		THMANYAH_CONTENT_DIR: contentDir,
-		THMANYAH_LOCALES: (config.locales ?? ["en"]).join(","),
-		THMANYAH_SITE_NAME: config.siteName ?? "Docs",
-		THMANYAH_GITHUB_REPO: config.github?.repo ?? "",
-		THMANYAH_GITHUB_BRANCH: config.github?.branch ?? "main"
+		CONTENT_DIR: contentDir,
+		LOCALES: (config.locales ?? ["en"]).join(","),
+		NEXT_PUBLIC_SITE_NAME: config.siteName ?? "Docs",
+		GITHUB_REPO: config.github?.repo,
+		SECTIONS: JSON.stringify(config.sections ?? {}),
+		NAV_LINKS: JSON.stringify(config.nav?.links ?? [])
 	};
 }
 
@@ -37056,7 +37067,7 @@ async function dev() {
 	const fallbackDir = resolve(process.cwd(), ".sudocs");
 	console.log(import_picocolors.default.cyan("8n") + import_picocolors.default.dim(` dev → ${contentDir}`));
 	if (!process.env.SUDOCS_LOCAL) console.log(import_picocolors.default.dim("  checking for updates..."));
-	const { updated, hash, dir: sudocsDir } = await prepareSudocs(fallbackDir);
+	const { updated, hash, dir: sudocsDir } = await prepareSudocs(fallbackDir, { version: config.version });
 	if (updated) console.log(import_picocolors.default.green("✓") + import_picocolors.default.dim(` starter updated to ${hash.slice(0, 7)}`));
 	if (process.env.SUDOCS_LOCAL) console.log(import_picocolors.default.yellow("⚑") + import_picocolors.default.dim(` using local starter → ${sudocsDir}`));
 	await R$1(getSudocsBin(sudocsDir, "next"), ["dev"], { nodeOptions: {
@@ -37080,7 +37091,7 @@ async function build() {
 	const fallbackDir = resolve(process.cwd(), ".sudocs");
 	console.log(import_picocolors.default.cyan("8n") + import_picocolors.default.dim(` build → ${contentDir}`));
 	if (!process.env.SUDOCS_LOCAL) console.log(import_picocolors.default.dim("  checking for updates..."));
-	const { updated, hash, dir: sudocsDir } = await prepareSudocs(fallbackDir);
+	const { updated, hash, dir: sudocsDir } = await prepareSudocs(fallbackDir, { version: config.version });
 	if (updated) console.log(import_picocolors.default.green("✓") + import_picocolors.default.dim(` starter updated to ${hash.slice(0, 7)}`));
 	await R$1(getSudocsBin(sudocsDir, "next"), ["build"], { nodeOptions: {
 		cwd: sudocsDir,
@@ -37112,11 +37123,22 @@ const SCAFFOLD = {
   content: "./content",
   locales: ["en"],
   siteName: "Docs",
+
+  // Pin to a specific starter version (git tag or commit SHA).
+  // Remove this line to always track the latest release.
+  // version: "v1.0.0",
+
+  // Sections auto-show when content exists, auto-hide when empty.
+  // Set a section to false to hide it even if content is present.
+  // sections: { api: false },
+
+  // Add links to the top navigation bar.
+  // nav: { links: [{ text: "Blog", url: "https://example.com/blog" }] },
 };
 `,
 	["content/docs/en/meta.json"]: JSON.stringify({
 		title: "Documentation",
-		pages: ["index"]
+		pages: ["index", "getting-started"]
 	}, null, 2) + "\n",
 	["content/docs/en/index.mdx"]: `---
 title: Introduction
@@ -37124,6 +37146,19 @@ description: Welcome to the docs.
 ---
 
 Welcome to your documentation. Edit files in \`content/\` and run \`8n dev\` to start.
+`,
+	["content/docs/en/getting-started/meta.json"]: JSON.stringify({
+		title: "Getting Started",
+		pages: ["installation"]
+	}, null, 2) + "\n",
+	["content/docs/en/getting-started/installation.mdx"]: `---
+title: Installation
+description: How to install and set up the project.
+---
+
+## Installation
+
+Add your installation steps here.
 `,
 	["content/changelog/en/meta.json"]: JSON.stringify({ title: "Changelog" }, null, 2) + "\n",
 	["content/changelog/en/v1.0.0.mdx"]: `---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahmedrowaihi/8n",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Thmanyah Docs — run your docs site from your content directory",
   "type": "module",
   "bin": {