@griddo/core 12.9.0-rc.1 → 12.9.0

package/dist/types/core/index.d.ts

@@ -336,13 +336,137 @@ interface ContentPresence {
 interface JsConversionOptions {
     /** Extract metadata from HTML */
     extractMetadata?: boolean;
-    /** Skip image conversion (keep as HTML) */
+    /** Drop the images: neither the image nor its alternative text survives */
     skipImages?: boolean;
     /** List of HTML tags to strip */
     stripTags?: Array<string>;
+    /** Preprocessing options */
+    preprocessing?: JsPreprocessingOptions;
     /** Enable debug mode with diagnostic warnings */
     debug?: boolean;
 }
+/** Preprocessing options */
+interface JsPreprocessingOptions {
+    /** Enable preprocessing (discards header and nav elements) */
+    enabled?: boolean;
+    /** Remove navigation elements */
+    removeNavigation?: boolean;
+    /** Remove form elements */
+    removeForms?: boolean;
+}
+/** What the markdown does with the images of the page */
+type LlmsImages = "dedupe" | "keep" | "skip";
+/** Options for the per-page markdown generated for LLMs */
+interface LlmsMarkdownConfig {
+    /**
+     * What the markdown does with the images of the page:
+     *
+     * - `"skip"` drops them. The converter writes neither the image nor its
+     *   alternative text, so the page loses them. This is the default.
+     * - `"keep"` converts every one of them.
+     * - `"dedupe"` converts them, and collapses an image that a module paints
+     *   twice —one for desktop, one for mobile, toggled by CSS— into a single
+     *   one.
+     */
+    images?: LlmsImages;
+    /**
+     * Collect the links dropped with the header and the nav menu into a
+     * `## Navigation` section at the top of the markdown. Opt-in: off unless
+     * the instance sets it to `true`.
+     */
+    includeNav?: boolean;
+    /**
+     * Point the internal links of the markdown at the markdown mirror of the
+     * target page. With `false` they keep pointing at the page itself. Defaults
+     * to `true`.
+     */
+    linkToMarkdown?: boolean;
+    /**
+     * Write the internal links of the markdown as absolute URLs, with their
+     * origin. With `false` they keep the root path the CMS wrote. Defaults to
+     * `true`.
+     */
+    absoluteLinks?: boolean;
+    /**
+     * Open the markdown with a YAML front matter holding the metadata of the
+     * page: title, description, url, locale, site and render date. Defaults to
+     * `true`.
+     */
+    frontMatter?: boolean;
+    /**
+     * Raw options for the HTML to markdown converter, which replace the ones
+     * that Griddo passes to it. The images are not here, because `images` owns
+     * that decision.
+     */
+    converter?: Omit<JsConversionOptions, "skipImages">;
+}
+/** Options for the `llms.txt` index of the domain */
+interface LlmsIndexConfig {
+    /**
+     * Your own markdown, placed in `llms.txt` between the header that Griddo
+     * generates and the list of page links.
+     */
+    header?: string;
+    /**
+     * Your own markdown, placed in `llms.txt` after the list of page links.
+     */
+    footer?: string;
+}
+/**
+ * The flat shape of `llms`, which held the options of three artifacts and the
+ * ones of the converter in a single level. Griddo still reads these keys, and
+ * the render warns about each one that it finds. A later version removes them.
+ */
+interface DeprecatedLlmsConfig {
+    /** @deprecated Use `markdown.converter.extractMetadata`. */
+    extractMetadata?: boolean;
+    /** @deprecated Use `markdown.images`: `"keep"` or `"dedupe"`. */
+    skipImages?: boolean;
+    /** @deprecated Use `markdown.converter.stripTags`. */
+    stripTags?: Array<string>;
+    /** @deprecated Use `markdown.converter.preprocessing`. */
+    preprocessing?: JsPreprocessingOptions;
+    /** @deprecated Use `markdown.converter.debug`. */
+    debug?: boolean;
+    /** @deprecated Use `markdown.includeNav`. */
+    includeNav?: boolean;
+    /** @deprecated Use `markdown.images`: `"dedupe"` or `"keep"`. */
+    dedupeImages?: boolean;
+    /** @deprecated Use `markdown.linkToMarkdown`. */
+    linkToMarkdown?: boolean;
+    /** @deprecated Use `markdown.absoluteLinks`. */
+    absoluteLinks?: boolean;
+    /** @deprecated Use `markdown.frontMatter`. */
+    frontMatter?: boolean;
+    /** @deprecated Use `index.header`. */
+    header?: string;
+    /** @deprecated Use `index.footer`. */
+    footer?: string;
+}
+/**
+ * Options for the LLM surface of the site. Each artifact keeps its own group,
+ * so the instance reads the path and knows which file the option changes.
+ */
+interface LlmsConfig extends DeprecatedLlmsConfig {
+    /** The markdown mirror of each page */
+    markdown?: LlmsMarkdownConfig;
+    /** The `llms.txt` index of the domain */
+    index?: LlmsIndexConfig;
+    /**
+     * Announce the LLM surface of the site from the page itself, with the link
+     * relations that llmstxt.org recommends: `alternate` for the markdown mirror
+     * of the page, and `describedby` for the `llms.txt` that covers it. Defaults
+     * to `false`: announcing the mirror invites search engines to index it, so
+     * turn it on once the CDN answers the markdown with `X-Robots-Tag: noindex`.
+     * Each link appears only when the render writes that file.
+     *
+     * Leaving it off does not hide the mirror. The links of `llms.txt` already
+     * point at it whenever the render writes it, and that file is a door of its
+     * own. This switch decides one of the two, so the `noindex` is what actually
+     * settles the duplicate content.
+     */
+    discoveryLinks?: boolean;
+}
 interface Config {
     autotypes?: Partial<Schema.AutoTypesConfig>;
     schemas: {
@@ -355,7 +479,7 @@ interface Config {
             themes: Schema.Themes;
             subthemes?: Array<string>;
             socials?: Schema.Socials;
-            llms?: JsConversionOptions;
+            llms?: LlmsConfig;
         };
         ui: {
             components: Record<string, Schema.Component>;
@@ -375,4 +499,4 @@ interface Config {
         };
     };
 }
-export type { BackgroundImageSizesProps, Breadcrumb, CloudinaryDefaults, Config, ContentPresence, ContentTypeRelations, FetchPriority, FooterModule, FullPath, GriddoDamDefaults, HeaderModule, ImageCropType, ImageDecoding, ImageFormats, ImageLoading, ImagePosition, ImageTransform, ISOLocale, JsConversionOptions, LibraryComponentProps, ListContentType, Locale, LocaleTranslations, NavigationModule, Page, PageIntegration, PageLanguage, Renderers, ResponsiveImageProps, Site, SiteLanguage, SocialName, TimeZone };
+export type { BackgroundImageSizesProps, Breadcrumb, CloudinaryDefaults, Config, ContentPresence, ContentTypeRelations, DeprecatedLlmsConfig, FetchPriority, FooterModule, FullPath, GriddoDamDefaults, HeaderModule, ImageCropType, ImageDecoding, ImageFormats, ImageLoading, ImagePosition, ImageTransform, ISOLocale, JsConversionOptions, JsPreprocessingOptions, LibraryComponentProps, ListContentType, LlmsConfig, LlmsImages, LlmsIndexConfig, LlmsMarkdownConfig, Locale, LocaleTranslations, NavigationModule, Page, PageIntegration, PageLanguage, Renderers, ResponsiveImageProps, Site, SiteLanguage, SocialName, TimeZone };

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@griddo/core",
 	"description": "Reload version of Griddo Core",
 	"license": "UNLICENSED",
-	"version": "12.9.0-rc.1",
+	"version": "12.9.0",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -119,5 +119,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "6ca432142f7b2645958c4e65471bb9b8a6e7cc82"
+	"gitHead": "d3a3e8da5f6a9c89f60c6055a0f133a0d7c05691"
 }