@knitli/docs-components 1.3.1 → 1.3.2

package/dist/styles/custom.css

@@ -1,73 +0,0 @@
-/* Custom styles for docs-home - Override Knitli global styles */
-/* Reset body to use Starlight defaults instead of Knitli's parchment background */
-body {
-  background: var(--sl-color-bg) !important;
-  font-family:
-    "DM Mono", "Roboto Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace !important;
-  color: var(--sl-color-text) !important;
-}
-
-/* Ensure main content panel uses Starlight theme colors */
-.content-panel {
-  background-color: var(--sl-color-bg-nav) !important;
-}
-
-/* Ensure page background respects Starlight theme, and fills viewport height */
-.page {
-  background-color: var(--sl-color-bg) !important;
-  min-height: 100dvh !important;
-  flex-direction: column !important;
-}
-
-/* Make the main frame grow to push footer to bottom on short pages */
-.main-frame {
-  flex: 1 !important;
-  display: flex !important;
-  flex-direction: column !important;
-  background-color: var(--sl-color-bg-nav);
-}
-
-.main-frame > main {
-  flex: 1 !important;
-}
-
-/* Splash page hero - keep transparent but ensure text uses Starlight colors */
-.splash .hero {
-  background-color: transparent;
-  color: var(--sl-color-text) !important;
-}
-
-/* Dark mode colors. */
-:root {
-  --font-sans:
-    "DM Mono", "Roboto Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace;
-  --font-mono: "JetBrains Mono", Menlo, Consolas, "DejaVu Sans Mono", monospace;
-  --sl-subnav-height: 2rem;
-
-  --sl-color-accent-low: #3d170d;
-  --sl-color-accent: #ba3100;
-  --sl-color-accent-high: #eebbad;
-  --sl-color-white: #ffffff;
-  --sl-color-gray-1: #efedef;
-  --sl-color-gray-2: #cac7ca;
-  --sl-color-gray-3: #a8a2a7;
-  --sl-color-gray-4: #5c565a;
-  --sl-color-gray-5: #3b363a;
-  --sl-color-gray-6: #2a2529;
-  --sl-color-black: #1a1719;
-}
-/* Light mode colors. */
-:root[data-theme="light"] {
-  --sl-color-accent-low: #f4cdc2;
-  --sl-color-accent: #982600;
-  --sl-color-accent-high: #581b0b;
-  --sl-color-white: #1a1719;
-  --sl-color-gray-1: #2a2529;
-  --sl-color-gray-2: #3b363a;
-  --sl-color-gray-3: #5c565a;
-  --sl-color-gray-4: #8f898e;
-  --sl-color-gray-5: #c4c1c3;
-  --sl-color-gray-6: #efedef;
-  --sl-color-gray-7: #f7f6f7;
-  --sl-color-black: #ffffff;
-}

package/dist/styles/index.d.ts

@@ -1,2 +0,0 @@
-export declare const docsStyle: string;
-//# sourceMappingURL=index.d.ts.map

package/dist/styles/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/styles/index.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,SAAS,QAAgC,CAAC"}

package/dist/templates/AstroConfigTemplate.d.mts

@@ -1,3 +0,0 @@
-declare const _default: import("astro").AstroUserConfig<never, never, import("astro").FontProvider<never>[]>;
-export default _default;
-//# sourceMappingURL=AstroConfigTemplate.d.mts.map

package/dist/templates/AstroConfigTemplate.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AstroConfigTemplate.d.mts","sourceRoot":"","sources":["../../src/templates/AstroConfigTemplate.mjs"],"names":[],"mappings":""}

package/dist/templates/AstroConfigTemplate.mjs

@@ -1,305 +0,0 @@
-// SPDX-FileCopyrightText: 2026 Knitli Inc.
-//
-// SPDX-License-Identifier: Apache-2.0
-// @ts-check
-// import cloudflare from "@astrojs/cloudflare";
-// import mdx from "@astrojs/mdx";
-// import sitemap from "@astrojs/sitemap";
-import starlight from "@astrojs/starlight";
-// import favicons from "astro-favicons";
-import { DocsAssets } from "@knitli/docs-components";
-import { defineConfig, fontProviders } from "astro/config";
-import { searchForWorkspaceRoot } from "vite";
-// import starlightHeadingBadges from "starlight-heading-badges";
-// import starlightContextualMenu from "starlight-contextual-menu";
-// import starlightTags from "starlight-tags";
-// import starlightLlmsText from "starlight-llms-txt";
-const { headlineLogoDark, headlineLogoLight, variables, docsStyle, faviconIco, faviconSvg, } = DocsAssets;
-const appName = "APP_NAME";
-const description = "DESCRIPTION";
-const shikiCfg = {
-    themes: ["catppuccin-latte", "catppuccin-mocha"],
-    bundledLangs: [
-        "ansi",
-        "rust",
-        "astro",
-        "yaml",
-        "bash",
-        "python",
-        "json",
-        "toml",
-        "typescript",
-        "markdown",
-    ],
-    langAlias: {
-        sh: "bash",
-        js: "typescript",
-        py: "python",
-        rs: "rust",
-        md: "markdown",
-        yml: "yaml",
-    },
-};
-// https://astro.build/config
-export default defineConfig({
-    site: "https://docs.knitli.com",
-    base: `/${appName.toLowerCase()}/`,
-    /*
-    adapter: cloudflare({
-      experimental: {
-        headersAndRedirectsDevModeSupport: true,
-      },
-      configPath: "./wrangler.jsonc",
-      imageService: "compile",
-    }),
-  */
-    favicon: faviconIco,
-    // Image optimization
-    image: {
-        service: {
-            entrypoint: "astro/assets/services/sharp",
-        },
-        responsiveStyles: true,
-        layout: "constrained",
-        domains: [
-            "github.com",
-            "raw.githubusercontent.com",
-            "docs.knitli.com",
-            "knitli.com",
-            "avatars.githubusercontent.com",
-            "ui-avatars.com",
-            `${appName.toLowerCase()}.knitli.com`,
-        ],
-    },
-    fonts: [
-        {
-            provider: fontProviders.google,
-            name: "DM Mono",
-            cssVariable: "--font-sans",
-            weights: [400, 500, 700],
-            styles: ["normal", "italic"],
-            subsets: ["latin"],
-            formats: ["woff2"],
-            fallbacks: [
-                "Roboto Mono",
-                "Menlo",
-                "Consolas",
-                "DejaVu Sans Mono",
-                "monospace",
-            ],
-        },
-        {
-            provider: fontProviders.google,
-            name: "JetBrains Mono",
-            cssVariable: "--font-mono",
-            weights: [400, 500, 700],
-            styles: ["normal", "italic"],
-            subsets: ["latin"],
-            formats: ["woff2"],
-            fallbacks: [
-                "DM Mono",
-                "Roboto Mono",
-                "Menlo",
-                "Consolas",
-                "DejaVu Sans Mono",
-                "monospace",
-            ],
-        },
-    ],
-    headingIdCompat: true,
-    preserveScriptOrder: true,
-    // Build optimizations
-    build: {
-        inlineStylesheets: "auto",
-        assets: "_astro",
-    },
-    markdown: {
-        shikiConfig: {
-            ...Object.fromEntries(Object.entries(shikiCfg).map(([key, value]) => key === "themes"
-                ? [
-                    key,
-                    {
-                        light: "catppuccin-latte",
-                        dark: "catppuccin-mocha",
-                    },
-                ]
-                : [key, value])),
-        },
-    },
-    trailingSlash: "always",
-    // Vite configuration for better bundling
-    vite: {
-        server: {
-            fs: {
-                allow: [searchForWorkspaceRoot(process.cwd())],
-            },
-        },
-        assetsInclude: [
-            "src/*.webp",
-            "src/*.png",
-            "src/*.jpg",
-            "src/*.jpeg",
-            "src/*.svg",
-            "src/*.avif",
-        ],
-        build: {
-            cssCodeSplit: true,
-            cssMinify: "lightningcss",
-            rolldownOptions: {
-                output: {
-                    experimental: {
-                        nativeMagicString: true,
-                    },
-                },
-                treeshake: "smallest",
-                optimization: {
-                    inlineConst: "smart",
-                },
-                ssr: false,
-            },
-        },
-        css: {
-            lightningcss: {},
-        },
-    },
-    prefetch: {
-        defaultStrategy: "viewport",
-    },
-    experimental: {
-        chromeDevtoolsWorkspace: true,
-        clientPrerender: true,
-        contentIntellisense: true,
-        svgo: {
-            plugins: [
-                {
-                    name: "preset-default",
-                    params: {
-                        overrides: {
-                            removeMetadata: false,
-                        },
-                    },
-                },
-            ],
-        },
-        rustCompiler: true,
-    },
-    // Static site generation for Cloudflare
-    output: "static",
-    integrations: [
-        starlight({
-            title: `${appName} Docs`,
-            description: description,
-            logo: {
-                dark: headlineLogoDark,
-                light: headlineLogoLight,
-                alt: "knitli logo",
-                replacesTitle: true,
-            },
-            editLink: {
-                baseUrl: `https://github.com/knitli/${appName.toLowerCase()}/edit/main/docs-site/src`,
-            },
-            expressiveCode: {
-                useStarlightDarkModeSwitch: true,
-                themes: ["catppuccin-latte", "catppuccin-mocha"],
-                removeUnusedThemes: true,
-                shiki: {
-                    ...Object.fromEntries(Object.entries(shikiCfg).filter(([key]) => key !== "themes")),
-                },
-            },
-            plugins: [
-            /*
-            astroD2({ skipGeneration: true }),
-            starlightLinksValidator(),
-    
-            starlightScrollToTop(),
-            starlightChangelogs(),
-            starlightIconsPlugin(),
-            starlightPageActions({ baseUrl: `https://docs.knitli.com/${appName.toLowerCase()}` }),
-            starlightIconsIntegration(),
-            starlightIconsPlugin(),
-            starlightHeadingBadges(), starlightContextualMenu({
-            actions: ["copy", "view", "claude", "chatgpt"], share: true,
-          }),
-          // We need to configure starlight-tags with a tags.yml.
-          //starlightTags(),
-          starlightLlmsText({
-            projectName: appName,
-            description: `${appName} is a pure-Rust fork of the popular data processing and ETL framework, [CocoIndex](https://cocoindex.io). ${appName} features a highly modular architecture, with all sources, targets, and functions (i.e. transforms) implemented as feature-gated plugins. This allows users to easily customize and extend the framework to fit their specific data processing needs, while keeping the core lightweight and efficient.
-            Like CocoIndex, ${appName} is fast, efficient, and works on data incrementally. Both libraries are built using a *dataflow architecture*, allowing you to easily define complex data processing pipelines with multiple sources, targets, and transforms in only a few lines of code. CocoIndex is built in Rust, but its entire API is only in Python, and does not allow for choosing integrations. ${appName} exposes a robust Rust API that allows you to choose exactly which sources, targets, and transforms you want to use.
-            `,
-            promote: ["getting-started*", "architecture*", "file-processing*", "transient-flow*"],
-            demote: ["contributing*", "changelog*"],
-            minify: {
-              whitespace: true,
-              note: true,
-              details: true,
-            }
-          })
-            */
-            ],
-            social: [
-                {
-                    icon: "github",
-                    label: "GitHub",
-                    href: `https://github.com/knitli/${appName.toLowerCase()}`,
-                },
-            ],
-            components: {
-                Footer: "@knitli/docs-components/Footer.astro",
-                PageFrame: "@knitli/docs-components/PageFrame.astro",
-            },
-            customCss: [variables, docsStyle, "./src/styles/custom.css"],
-            head: [
-                {
-                    tag: "meta",
-                    attrs: {
-                        property: "og:image",
-                        content: `https://docs.knitli.com/${appName.toLowerCase()}/og-image.png`,
-                    },
-                },
-                {
-                    tag: "meta",
-                    attrs: {
-                        property: "twitter:card",
-                        content: "summary_large_image",
-                    },
-                },
-            ],
-            sidebar: [
-                {
-                    label: "Guides",
-                    autogenerate: { directory: "guides" },
-                },
-                {
-                    label: "Examples",
-                    autogenerate: { directory: "examples" },
-                },
-                {
-                    label: "Reference",
-                    autogenerate: { directory: "reference" },
-                },
-            ],
-        }),
-        /*
-        mdx(),
-        favicons({
-          name: `${appName} Docs by Knitli`,
-          short_name: `${appName} Docs`,
-          input: {
-            favicons: [faviconSvg],
-          },
-        }),
-        sitemap({
-          filter: (page) => !/\^\/(?!cdn-cgi\/)/.test(page),
-          changefreq: "weekly",
-          priority: 0.4,
-          lastmod: new Date(),
-          namespaces: {
-            image: false,
-            video: false,
-          },
-        }),
-    
-        */
-    ],
-});

package/dist/types/index.d.ts

@@ -1,31 +0,0 @@
-/**
- * Site URLs configuration
- */
-export interface SiteUrls {
-    marketing: string;
-    blog: string;
-    docs: string;
-}
-/**
- * Props for DocsBreadcrumb component
- */
-export interface DocsBreadcrumbProps {
-    /**
-     * Current product name
-     */
-    product?: string;
-    /**
-     * URL to the product's documentation home
-     */
-    productUrl?: string;
-    /**
-     * Current path within the product docs
-     */
-    path?: string;
-    /**
-     * Visual variant of the breadcrumb
-     * @default 'default'
-     */
-    variant?: "default" | "compact" | "inline";
-}
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAUA;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;CAC5C"}