astro.config.mjs

import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
import mermaid from "astro-mermaid";
import { pluginCollapsibleSections } from "@expressive-code/plugin-collapsible-sections";
import { pluginLineNumbers } from "@expressive-code/plugin-line-numbers";

// https://astro.build/config
export default defineConfig({
  site: "https://codellm-devkit.info",
  integrations: [
    // Mermaid must run BEFORE Starlight so it can preprocess ```mermaid blocks.
    mermaid({
      theme: "neutral",
      autoTheme: true,
      mermaidConfig: {
        flowchart: { curve: "basis" },
      },
    }),
    starlight({
      title: "CLDK",
      tagline: "One analysis interface over every language: program analysis your agents can call.",
      description:
        "CLDK is a multilingual program analysis framework: one typed analysis facade over call graphs and symbol tables, the same across languages, ready to hand to a code LLM.",
      logo: {
        light: "./src/assets/logo-light.svg",
        dark: "./src/assets/logo-white.svg",
        replacesTitle: false,
      },
      favicon: "/favicon.png",
      customCss: ["./src/styles/docs.css"],
      expressiveCode: {
        plugins: [pluginCollapsibleSections(), pluginLineNumbers()],
        styleOverrides: {
          borderRadius: "0.4rem",
          frames: {
            shadowColor: "transparent",
          },
        },
        defaultProps: {
          // Opt in to line numbers per-block with showLineNumbers.
          showLineNumbers: false,
        },
      },
      head: [
        {
          tag: "link",
          attrs: { rel: "preconnect", href: "https://fonts.googleapis.com" },
        },
        {
          tag: "link",
          attrs: {
            rel: "preconnect",
            href: "https://fonts.gstatic.com",
            crossorigin: "",
          },
        },
        {
          tag: "link",
          attrs: {
            rel: "stylesheet",
            href: "https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@400;500;600;700&family=Space+Mono:wght@400;700&display=swap",
          },
        },
        // --- SEO: social card + og:type override (Starlight dedupes by
        // property/name, so these win over its defaults) ---
        {
          tag: "meta",
          attrs: { property: "og:type", content: "website" },
        },
        {
          tag: "meta",
          attrs: {
            property: "og:image",
            content: "https://codellm-devkit.info/og-image.png",
          },
        },
        {
          tag: "meta",
          attrs: { property: "og:image:width", content: "1200" },
        },
        {
          tag: "meta",
          attrs: { property: "og:image:height", content: "630" },
        },
        {
          tag: "meta",
          attrs: {
            name: "twitter:image",
            content: "https://codellm-devkit.info/og-image.png",
          },
        },
        // --- SEO: structured data so search engines model CLDK as software ---
        {
          tag: "script",
          attrs: { type: "application/ld+json" },
          content: JSON.stringify({
            "@context": "https://schema.org",
            "@type": "SoftwareApplication",
            name: "CodeLLM-DevKit",
            alternateName: "CLDK",
            applicationCategory: "DeveloperApplication",
            operatingSystem: "Linux, macOS, Windows",
            description:
              "CodeLLM-DevKit (CLDK) is a multilingual program analysis framework: one typed analysis facade over call graphs and symbol tables, the same interface across languages, ready to hand to a code LLM.",
            url: "https://codellm-devkit.info/",
            downloadUrl: "https://pypi.org/project/cldk/",
            softwareHelp: "https://codellm-devkit.info/quickstart/",
            license: "https://www.apache.org/licenses/LICENSE-2.0",
            sameAs: [
              "https://github.com/codellm-devkit/python-sdk",
              "https://pypi.org/project/cldk/",
              "https://arxiv.org/abs/2410.13007",
            ],
            offers: {
              "@type": "Offer",
              price: "0",
              priceCurrency: "USD",
            },
          }),
        },
      ],
      social: [
        {
          icon: "github",
          label: "CLDK on GitHub",
          href: "https://github.com/codellm-devkit",
        },
        {
          icon: "seti:python",
          label: "CLDK on PyPI",
          href: "https://pypi.org/project/cldk",
        },
        {
          icon: "discord",
          label: "CLDK on Discord",
          href: "https://discord.gg/zEjz9YrmqN",
        },
      ],
      editLink: {
        baseUrl: "https://github.com/codellm-devkit/docs/edit/main/",
      },
      sidebar: [
        {
          label: "Start here",
          items: [
            { label: "Home", link: "/", attrs: { "data-cldk-icon": "layers-16" } },
            { label: "What is CLDK?", slug: "what-is-cldk", attrs: { "data-cldk-icon": "cube-16" } },
            { label: "Quickstart", slug: "quickstart", attrs: { "data-cldk-icon": "flame-16" } },
            { label: "Installation", slug: "installing", attrs: { "data-cldk-icon": "archive-16" } },
          ],
        },
        {
          label: "Guides",
          items: [
            { label: "Core concepts", slug: "guides/concepts", attrs: { "data-cldk-icon": "learning-16" } },
            { label: "Common tasks", slug: "guides/common-tasks", attrs: { "data-cldk-icon": "workflow-16" } },
            {
              label: "Code Context Agent",
              slug: "cocoa",
              attrs: { "data-cldk-icon": "chat-16" },
            },
          ],
        },
        {
          label: "Examples",
          items: [
            { label: "Overview", slug: "examples", attrs: { "data-cldk-icon": "manual-16" } },
            { label: "Python examples", slug: "examples/python", attrs: { "data-cldk-icon": "python" } },
            { label: "Java examples", slug: "examples/java", attrs: { "data-cldk-icon": "java" } },
          ],
        },
        {
          label: "At scale",
          items: [
            { label: "Analysis at scale", slug: "at-scale", attrs: { "data-cldk-icon": "globe-network-16" } },
            { label: "Deploy on Kubernetes", slug: "at-scale/kubernetes", attrs: { "data-cldk-icon": "cloud-16" } },
          ],
        },
        {
          label: "SDKs",
          items: [
            { label: "Overview", slug: "reference/sdks", attrs: { "data-cldk-icon": "manual-16" } },
            {
              label: "Python SDK",
              items: [
                { label: "Overview", slug: "reference/python-api", attrs: { "data-cldk-icon": "manual-16" } },
                { label: "Core (CLDK)", slug: "reference/python-api/core", attrs: { "data-cldk-icon": "layers-16" } },
                { label: "Python analysis", slug: "reference/python-api/python", attrs: { "data-cldk-icon": "python" } },
                { label: "Java analysis", slug: "reference/python-api/java", attrs: { "data-cldk-icon": "java" } },
                { label: "TypeScript analysis", slug: "reference/python-api/typescript", attrs: { "data-cldk-icon": "typescript" } },
              ],
            },
            {
              label: "TypeScript SDK",
              link: "https://github.com/codellm-devkit/typescript-sdk",
              attrs: { "data-cldk-icon": "typescript", target: "_blank", rel: "noopener noreferrer" },
            },
          ],
        },
        {
          label: "Backends",
          items: [
            { label: "Overview", slug: "backends", attrs: { "data-cldk-icon": "manual-16" } },
            { label: "codeanalyzer-python", slug: "backends/codeanalyzer-python", attrs: { "data-cldk-icon": "python" } },
            { label: "codeanalyzer-java", slug: "backends/codeanalyzer-java", attrs: { "data-cldk-icon": "java" } },
            { label: "codeanalyzer-ts", slug: "backends/codeanalyzer-ts", attrs: { "data-cldk-icon": "typescript" } },
          ],
        },
        {
          label: "Contributing",
          items: [
            { label: "Overview", slug: "contributing", attrs: { "data-cldk-icon": "manual-16" } },
            { label: "Add a language backend (Go)", slug: "contributing/add-language-backend", attrs: { "data-cldk-icon": "go" } },
            { label: "Add a Rust frontend", slug: "contributing/rust-frontend", attrs: { "data-cldk-icon": "rust" } },
          ],
        },
        {
          label: "Resources",
          items: [
            { label: "Cheat sheet", slug: "resources/cheatsheet", attrs: { "data-cldk-icon": "results-16" } },
          ],
        },
      ],
    }),
  ],
});