hyperbook 0.62.0 → 0.63.0

package/dist/index.js

@@ -63354,6 +63354,116 @@ const lunr_1 = __importDefault(__nccwpck_require__(12203));
 const markdown_1 = __nccwpck_require__(72384);
 const package_json_1 = __importDefault(__nccwpck_require__(8330));
 exports.ASSETS_FOLDER = "__hyperbook_assets";
+/**
+ * Generates an llms.txt file by combining all markdown files in order
+ */
+async function generateLlmsTxt(root, rootOut, hyperbookJson, pagesAndSections, version) {
+    const lines = [];
+    // Add header with book name and version
+    lines.push(`<SYSTEM>${hyperbookJson.name} - Version ${version}</SYSTEM>`);
+    lines.push(""); // Empty line after header
+    // Get all book files once to avoid repeated file system operations
+    const allFiles = await fs_1.vfile.listForFolder(root, "book");
+    // Helper function to recursively process sections and pages
+    const processSection = async (section, level = 0) => {
+        // Skip if hidden
+        if (section.hide) {
+            return;
+        }
+        // Add section header if it has content
+        if (section.href && !section.isEmpty) {
+            const file = allFiles.find((f) => f.path.href === section.href);
+            if (file) {
+                // Add section name as a header
+                lines.push(`# ${section.name}`);
+                lines.push("");
+                // Get the markdown content without frontmatter
+                const content = file.markdown.content.trim();
+                if (content) {
+                    lines.push(content);
+                    lines.push(""); // Empty line after content
+                }
+            }
+        }
+        // Process nested pages
+        if (section.pages) {
+            for (const page of section.pages) {
+                await processPage(page);
+            }
+        }
+        // Process nested sections
+        if (section.sections) {
+            for (const subsection of section.sections) {
+                await processSection(subsection, level + 1);
+            }
+        }
+    };
+    const processPage = async (page) => {
+        // Skip if hidden or empty
+        if (page.hide || page.isEmpty) {
+            return;
+        }
+        if (page.href) {
+            const file = allFiles.find((f) => f.path.href === page.href);
+            if (file) {
+                // Add page name as a header
+                lines.push(`# ${page.name}`);
+                lines.push("");
+                // Get the markdown content without frontmatter
+                const content = file.markdown.content.trim();
+                if (content) {
+                    lines.push(content);
+                    lines.push(""); // Empty line after content
+                }
+            }
+        }
+    };
+    // Process root-level pages first
+    for (const page of pagesAndSections.pages) {
+        await processPage(page);
+    }
+    // Process sections
+    for (const section of pagesAndSections.sections) {
+        await processSection(section);
+    }
+    // Write the llms.txt file
+    lines.push(`
+When you are writing a hyperbook syntax you must use markdown plus the documented elements, also keep track of colons. Colons act like parentheses in programming languages. Every opening colon must have a closing colon. For example, in the syntax :bold text: the first colon opens the bold formatting and the second colon closes it. If there is a missing colon, it can lead to formatting errors or unexpected behavior in the rendered output. Always ensure that colons are properly paired to maintain the intended structure and appearance of your hyperbook content.
+
+Single colons are inline elements.
+
+Example: :t[Test]
+
+Double colons are block elements.
+
+Example: ::p5{src="sketch.js"}
+
+Triple colons are special elements that can contain other elements inside them.
+
+Example:
+
+:::::alert{info}
+
+::::tabs
+
+:::tab{title="JavaScript"}
+
+Hi
+
+:::
+
+
+::::
+
+:::::
+
+When you want to nest elements you need to increase the number of colons by one for each level of nesting. The outer level should have the most colons.
+
+Also you need to use unique ids when the element supports it.
+`);
+    const llmsTxtContent = lines.join("\n");
+    await promises_1.default.writeFile(path_1.default.join(rootOut, "llms.txt"), llmsTxtContent);
+}
 async function runBuildProject(project, rootProject, out, filter) {
     const name = fs_1.hyperproject.getName(project);
     if (project.type === "book") {
@@ -63823,6 +63933,11 @@ const SEARCH_DOCUMENTS = ${JSON.stringify(documents)};
   // GENERATED
   const locales = ${locales};
 `));
+    // Generate llms.txt if enabled
+    if (hyperbookJson.llms) {
+        console.log(`${chalk_1.default.blue(`[${prefix}]`)} Generating llms.txt`);
+        await generateLlmsTxt(root, rootOut, hyperbookJson, pagesAndSections, package_json_1.default.version);
+    }
     console.log(`${chalk_1.default.green(`[${prefix}]`)} Build success: ${rootOut}`);
 }
 
@@ -183326,7 +183441,7 @@ module.exports = /*#__PURE__*/JSON.parse('{"application/1d-interleaved-parityfec
 /***/ ((module) => {
 
 "use strict";
-module.exports = /*#__PURE__*/JSON.parse('{"name":"hyperbook","version":"0.62.0","author":"Mike Barkmin","homepage":"https://github.com/openpatch/hyperbook#readme","license":"MIT","bin":{"hyperbook":"./dist/index.js"},"files":["dist"],"publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/openpatch/hyperbook.git","directory":"packages/hyperbook"},"bugs":{"url":"https://github.com/openpatch/hyperbook/issues"},"engines":{"node":">=12.22.0"},"scripts":{"version":"pnpm build","lint":"tsc --noEmit","dev":"ncc build ./index.ts -w -o dist/","build":"rimraf dist && ncc build ./index.ts -o ./dist/ --no-cache --no-source-map-register --external favicons --external sharp && node postbuild.mjs"},"dependencies":{"favicons":"^7.2.0"},"devDependencies":{"@hyperbook/fs":"workspace:*","@hyperbook/markdown":"workspace:*","@hyperbook/types":"workspace:*","@pnpm/exportable-manifest":"1000.0.6","@types/archiver":"6.0.3","@types/async-retry":"1.4.9","@types/cross-spawn":"6.0.6","@types/lunr":"^2.3.7","@types/prompts":"2.4.9","@types/tar":"6.1.13","@types/ws":"^8.5.14","@vercel/ncc":"0.38.3","archiver":"7.0.1","async-retry":"1.3.3","chalk":"5.4.1","chokidar":"4.0.3","commander":"12.1.0","cpy":"11.1.0","cross-spawn":"7.0.6","domutils":"^3.2.2","extract-zip":"^2.0.1","got":"12.6.0","htmlparser2":"^10.0.0","lunr":"^2.3.9","lunr-languages":"^1.14.0","mime":"^4.0.6","prompts":"2.4.2","rimraf":"6.0.1","tar":"7.4.3","update-check":"1.5.4","ws":"^8.18.0"}}');
+module.exports = /*#__PURE__*/JSON.parse('{"name":"hyperbook","version":"0.63.0","author":"Mike Barkmin","homepage":"https://github.com/openpatch/hyperbook#readme","license":"MIT","bin":{"hyperbook":"./dist/index.js"},"files":["dist"],"publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/openpatch/hyperbook.git","directory":"packages/hyperbook"},"bugs":{"url":"https://github.com/openpatch/hyperbook/issues"},"engines":{"node":">=12.22.0"},"scripts":{"version":"pnpm build","lint":"tsc --noEmit","dev":"ncc build ./index.ts -w -o dist/","build":"rimraf dist && ncc build ./index.ts -o ./dist/ --no-cache --no-source-map-register --external favicons --external sharp && node postbuild.mjs"},"dependencies":{"favicons":"^7.2.0"},"devDependencies":{"@hyperbook/fs":"workspace:*","@hyperbook/markdown":"workspace:*","@hyperbook/types":"workspace:*","@pnpm/exportable-manifest":"1000.0.6","@types/archiver":"6.0.3","@types/async-retry":"1.4.9","@types/cross-spawn":"6.0.6","@types/lunr":"^2.3.7","@types/prompts":"2.4.9","@types/tar":"6.1.13","@types/ws":"^8.5.14","@vercel/ncc":"0.38.3","archiver":"7.0.1","async-retry":"1.3.3","chalk":"5.4.1","chokidar":"4.0.3","commander":"12.1.0","cpy":"11.1.0","cross-spawn":"7.0.6","domutils":"^3.2.2","extract-zip":"^2.0.1","got":"12.6.0","htmlparser2":"^10.0.0","lunr":"^2.3.9","lunr-languages":"^1.14.0","mime":"^4.0.6","prompts":"2.4.2","rimraf":"6.0.1","tar":"7.4.3","update-check":"1.5.4","ws":"^8.18.0"}}');
 
 /***/ })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperbook",
-  "version": "0.62.0",
+  "version": "0.63.0",
   "author": "Mike Barkmin",
   "homepage": "https://github.com/openpatch/hyperbook#readme",
   "license": "MIT",
@@ -58,7 +58,7 @@
     "ws": "^8.18.0",
     "@hyperbook/fs": "0.20.0",
     "@hyperbook/markdown": "0.37.0",
-    "@hyperbook/types": "0.17.0"
+    "@hyperbook/types": "0.18.0"
   },
   "scripts": {
     "version": "pnpm build",