kss-modern 1.5.0 → 1.6.1

package/dist/node/lib/index.d.mts

@@ -153,6 +153,15 @@ interface StyleguideOptions {
      * the initial page load.
      */
     reloadPreviewsOnThemeChange?: boolean;
+    /**
+     * Let search engines index the generated styleguide.
+     *
+     * Off by default: a styleguide is internal documentation, and its output directory is usually
+     * served from a host that is reachable without being meant for the public. Every build writes a
+     * `robots.txt` into the output root, and every page carries a matching `<meta name="robots">` —
+     * `noindex, nofollow` while this is off, `index, follow` once it is on.
+     */
+    allowSearchEngineIndexing?: boolean;
     logoSignet?: {
         href: string;
     } | {

package/dist/node/lib/index.d.ts

@@ -153,6 +153,15 @@ interface StyleguideOptions {
      * the initial page load.
      */
     reloadPreviewsOnThemeChange?: boolean;
+    /**
+     * Let search engines index the generated styleguide.
+     *
+     * Off by default: a styleguide is internal documentation, and its output directory is usually
+     * served from a host that is reachable without being meant for the public. Every build writes a
+     * `robots.txt` into the output root, and every page carries a matching `<meta name="robots">` —
+     * `noindex, nofollow` while this is off, `index, follow` once it is on.
+     */
+    allowSearchEngineIndexing?: boolean;
     logoSignet?: {
         href: string;
     } | {

package/dist/node/lib/index.mjs

@@ -792,12 +792,13 @@ function extractMarkdownPath(input) {
   }
   return path2;
 }
+function compareReferences(a, b) {
+  return a.localeCompare(b, void 0, { numeric: true });
+}
 async function parse(input, contentDir) {
   const data = kssParser(input).sections.filter((section) => Boolean(section.reference));
   const overwrittenSectionsIds = [];
-  const sortedData = data.sort((a, b) => {
-    return a.reference.localeCompare(b.reference);
-  });
+  const sortedData = data.sort((a, b) => compareReferences(a.reference, b.reference));
   let output = [];
   async function computeDescription(description, rootHeadingLevel) {
     if (!description || !description.includes("Markdown:"))
@@ -960,7 +961,7 @@ async function parse(input, contentDir) {
   output.forEach((firstLevelSection) => {
     firstLevelSection.sections = firstLevelSection.sections.filter((section) => Boolean(section));
     firstLevelSection.sections.forEach((secondLevelSection) => {
-      secondLevelSection.sections = secondLevelSection.sections.filter((section) => Boolean(section)).sort((a, b) => a.id.localeCompare(b.id));
+      secondLevelSection.sections = secondLevelSection.sections.filter((section) => Boolean(section)).sort((a, b) => compareReferences(a.id, b.id));
     });
   });
   return {
@@ -1344,6 +1345,18 @@ async function logicalWriteFile(filepath, content) {
   await fs.writeFile(filepath, content);
 }
 
+const ROBOTS_FILE_NAME = "robots.txt";
+function generateRobotsTxt(allowSearchEngineIndexing) {
+  const rule = allowSearchEngineIndexing ? "Allow: /" : "Disallow: /";
+  return `# Generated by kss-modern
+User-agent: *
+${rule}
+`;
+}
+async function writeRobotsFile(outDir, allowSearchEngineIndexing) {
+  await logicalWriteFile(path.join(outDir, ROBOTS_FILE_NAME), generateRobotsTxt(allowSearchEngineIndexing));
+}
+
 async function generateFullPageFile(data) {
   const supportsDarkMode = !(data.deactivateDarkMode ?? false);
   const computedScriptTags = data.js.filter((entry) => entry.type !== "overwriteStyleguide").map((js) => {
@@ -1363,6 +1376,7 @@ async function generateFullPageFile(data) {
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="styleguide">
+    <meta name="robots" content="${data.allowSearchEngineIndexing ? "index, follow" : "noindex, nofollow"}">
     <link rel="icon" type="image/svg+xml" href="/styleguide-assets/favicon/fullpage.svg">
     ${data.ogImageUrl ? `<meta property="og:image" content="${data.ogImageUrl}">` : ""}
     ${typeof data.brandColor === "object" && "dark" in data.brandColor && "light" in data.brandColor ? `
@@ -2228,6 +2242,7 @@ async function generatePreviewFile(data) {
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="styleguide">
+    <meta name="robots" content="${data.allowSearchEngineIndexing ? "index, follow" : "noindex, nofollow"}">
     <link rel="icon" type="image/svg+xml" href="/styleguide-assets/favicon/preview.svg">
     ${data.ogImageUrl ? `<meta property="og:image" content="${data.ogImageUrl}">` : ""}
     ${typeof data.brandColor === "object" && "dark" in data.brandColor && "light" in data.brandColor ? `
@@ -2693,6 +2708,7 @@ async function writeFullPageFile(config, baseDirectory, section) {
       html: htmlMarkup,
       brandColor: config.brandColor,
       deactivateDarkMode: config.deactivateDarkMode,
+      allowSearchEngineIndexing: config.allowSearchEngineIndexing,
       ogImageUrl: config.plugins?.ogImage ? config.plugins.ogImage(section) : void 0
     });
   } catch (error) {
@@ -2750,6 +2766,7 @@ function writePreviewFile(config, context, firstLevelIndex, secondLevelIndex) {
     },
     brandColor: config.brandColor,
     deactivateDarkMode: config.deactivateDarkMode,
+    allowSearchEngineIndexing: config.allowSearchEngineIndexing,
     reloadPreviewsOnThemeChange: config.reloadPreviewsOnThemeChange,
     ogImageUrl: config.plugins?.ogImage ? config.plugins.ogImage(secondLevelSection) : void 0
   });
@@ -2886,7 +2903,11 @@ async function buildAll(input) {
       fileWriteTasks.push(writePreviewFile(config, context, firstLevelIndex, secondLevelIndex));
     });
   });
-  await Promise.all([copyStyleguideAssets(config), ...fileWriteTasks]);
+  await Promise.all([
+    copyStyleguideAssets(config),
+    writeRobotsFile(config.outDir, config.allowSearchEngineIndexing ?? false),
+    ...fileWriteTasks
+  ]);
   const errors = {};
   if (context.overwrittenSectionsIds.length > 0) {
     errors.overwrittenSectionsIds = context.overwrittenSectionsIds;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kss-modern",
   "type": "module",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "Modern KSS compatible styleguide generator",
   "keywords": [
     "kss",