@tiramisu-docs/kit 0.1.0

package/src/seo.ts

@@ -0,0 +1,193 @@
+export function generateSitemap(
+  docs: { slug: string }[],
+  options: { baseUrl: string; basePath?: string; locales?: { code: string }[]; defaultLocale?: string }
+): string {
+  const base = options.baseUrl.replace(/\/+$/, "")
+  const basePath = options.basePath ?? "/docs"
+  const buildDate = new Date().toISOString().split("T")[0]
+
+  const hasI18n = options.locales && options.locales.length > 0 && options.defaultLocale
+
+  let xml = `<?xml version="1.0" encoding="UTF-8"?>\n`
+  if (hasI18n) {
+    xml += `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/TR/xhtml11/xhtml11_schema.html">\n`
+  } else {
+    xml += `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n`
+  }
+
+  for (const doc of docs) {
+    const slug = doc.slug === "index" ? "" : `/${doc.slug}`
+    const url = `${base}${basePath}${slug}`
+    xml += `  <url>\n`
+    xml += `    <loc>${escapeXml(url)}</loc>\n`
+    xml += `    <lastmod>${buildDate}</lastmod>\n`
+    if (hasI18n) {
+      for (const locale of options.locales!) {
+        const localeUrl = `${base}${basePath}/${locale.code}${slug}`
+        xml += `    <xhtml:link rel="alternate" hreflang="${locale.code}" href="${escapeXml(localeUrl)}" />\n`
+      }
+    }
+    xml += `  </url>\n`
+  }
+
+  xml += `</urlset>\n`
+  return xml
+}
+
+function escapeXml(str: string): string {
+  return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;")
+}
+
+export function generateLlmsTxt(
+  docs: { slug: string; meta: { title?: string; description?: string; group?: string } }[],
+  options: { title: string; description: string; baseUrl: string; basePath?: string }
+): string {
+  const base = options.baseUrl.replace(/\/+$/, "")
+  const basePath = options.basePath ?? "/docs"
+
+  const lines: string[] = []
+  lines.push(`# ${options.title}`)
+  lines.push(`> ${options.description}`)
+  lines.push("")
+
+  const groups = new Map<string, typeof docs>()
+  for (const doc of docs) {
+    const group = doc.meta.group ?? "Docs"
+    if (!groups.has(group)) groups.set(group, [])
+    groups.get(group)!.push(doc)
+  }
+
+  for (const [group, groupDocs] of groups) {
+    lines.push(`## ${group}`)
+    for (const doc of groupDocs) {
+      const slug = doc.slug === "index" ? "" : `/${doc.slug}`
+      const url = `${base}${basePath}${slug}`
+      const title = doc.meta.title ?? doc.slug
+      const desc = doc.meta.description ? `: ${doc.meta.description}` : ""
+      lines.push(`- [${title}](${url})${desc}`)
+    }
+    lines.push("")
+  }
+
+  return lines.join("\n")
+}
+
+export function generateLlmsFullTxt(
+  searchIndex: { slug: string; title: string; group: string; text: string }[],
+  options: { title: string; description: string; baseUrl: string; basePath?: string }
+): string {
+  const base = options.baseUrl.replace(/\/+$/, "")
+  const basePath = options.basePath ?? "/docs"
+
+  const lines: string[] = []
+  lines.push(`# ${options.title}`)
+  lines.push(`> ${options.description}`)
+  lines.push("")
+
+  for (const entry of searchIndex) {
+    const slug = entry.slug === "index" ? "" : `/${entry.slug}`
+    const url = `${base}${basePath}${slug}`
+    lines.push(`---`)
+    lines.push(`## ${entry.title}`)
+    lines.push(`URL: ${url}`)
+    lines.push(`Group: ${entry.group}`)
+    lines.push("")
+    lines.push(entry.text)
+    lines.push("")
+  }
+
+  return lines.join("\n")
+}
+
+export function buildInstantOgUrl(pageUrl: string, options: { siteId: string; template?: string; theme?: "light" | "dark"; accentColor?: string; gradientBg?: boolean }): string {
+  const params = new URLSearchParams({ site: options.siteId, url: pageUrl })
+  if (options.template) params.set("template", options.template)
+  if (options.theme) params.set("theme", options.theme)
+  if (options.accentColor) params.set("accentColor", options.accentColor)
+  if (options.gradientBg) params.set("gradientBg", "true")
+  return `https://instantog.com/api/og?${params.toString()}`
+}
+
+export function buildCanonicalUrl(baseUrl: string, slug: string): string {
+  return `${baseUrl.replace(/\/+$/, "")}/docs/${slug}`
+}
+
+export function buildPageJsonLd(options: {
+  title: string
+  slug: string
+  baseUrl: string
+  description?: string
+  lastEdited?: string
+  siteName?: string
+  image?: string
+  author?: string
+}): string {
+  const url = buildCanonicalUrl(options.baseUrl, options.slug)
+  const ld: Record<string, unknown> = {
+    "@context": "https://schema.org",
+    "@type": "TechArticle",
+    headline: options.title,
+    url,
+    mainEntityOfPage: { "@type": "WebPage", "@id": url },
+    isPartOf: { "@type": "WebSite", name: options.siteName ?? undefined, url: options.baseUrl.replace(/\/+$/, "") },
+  }
+  if (options.description) ld.description = options.description
+  if (options.lastEdited) ld.dateModified = options.lastEdited
+  if (options.image) ld.image = options.image
+  if (options.author) ld.author = { "@type": "Person", name: options.author }
+  return JSON.stringify(ld)
+}
+
+export function generateSkillMd(
+  docs: { slug: string; meta: { title?: string; description?: string; group?: string } }[],
+  options: { title: string; description: string }
+): string {
+  const lines: string[] = []
+  lines.push(`---`)
+  lines.push(`name: ${options.title.toLowerCase().replace(/\s+/g, "-")}-docs`)
+  lines.push(`description: ${options.description}`)
+  lines.push(`---`)
+  lines.push("")
+  lines.push(`# ${options.title} Documentation`)
+  lines.push("")
+  lines.push(options.description)
+  lines.push("")
+
+  // Structure by groups
+  const groups = new Map<string, typeof docs>()
+  for (const doc of docs) {
+    const group = doc.meta.group ?? "Docs"
+    if (!groups.has(group)) groups.set(group, [])
+    groups.get(group)!.push(doc)
+  }
+
+  lines.push(`## Sections`)
+  lines.push("")
+  for (const [group, groupDocs] of groups) {
+    lines.push(`- **${group}** (${groupDocs.length} pages)`)
+  }
+  lines.push("")
+
+  lines.push(`## Key Pages`)
+  lines.push("")
+  for (const [group, groupDocs] of groups) {
+    lines.push(`### ${group}`)
+    for (const doc of groupDocs) {
+      const title = doc.meta.title ?? doc.slug
+      const desc = doc.meta.description ? ` - ${doc.meta.description}` : ""
+      lines.push(`- **${title}** (\`${doc.slug}\`)${desc}`)
+    }
+    lines.push("")
+  }
+
+  lines.push(`## MCP Integration`)
+  lines.push("")
+  lines.push(`This documentation is available via MCP server. Tools:`)
+  lines.push(`- \`search_docs\`: Search documentation by keyword`)
+  lines.push(`- \`read_doc\`: Read a specific documentation page`)
+  lines.push(`- \`list_sections\`: List all documentation sections`)
+  lines.push(`- \`list_pages\`: List pages, optionally filtered by section`)
+  lines.push(`- \`get_table_of_contents\`: Get headings for a page`)
+
+  return lines.join("\n") + "\n"
+}

package/src/tiramisu-grammar.ts

@@ -0,0 +1,80 @@
+import type { LanguageRegistration } from "shiki"
+
+export const tiramisuGrammar: LanguageRegistration = {
+  name: "tiramisu",
+  scopeName: "source.tiramisu",
+  patterns: [
+    { include: "#string" },
+    { include: "#function-call" },
+  ],
+  repository: {
+    string: {
+      patterns: [
+        {
+          name: "string.quoted.triple.tiramisu",
+          begin: '"""',
+          end: '"""',
+          patterns: [{ include: "#string-escape" }],
+        },
+        {
+          name: "string.quoted.double-double.tiramisu",
+          begin: '""(?!")',
+          end: '""',
+          patterns: [{ include: "#string-escape" }],
+        },
+        {
+          name: "string.quoted.double.tiramisu",
+          begin: '"(?!")',
+          end: '"',
+          patterns: [{ include: "#string-escape" }],
+        },
+      ],
+    },
+    "string-escape": {
+      name: "constant.character.escape.tiramisu",
+      match: "\\\\[,{}\\[\\]\\\\]",
+    },
+    "function-call": {
+      patterns: [
+        {
+          // Known built-in functions
+          match:
+            "\\b(meta|h[1-6]|bold|italic|code|link|image|codeblock|list|table|callout|tabs|steps|badge|quote|tasklist|columns|col|accordion|cards|card|filetree|folder|file|math|mermaid)\\s*(?=\\{)",
+          captures: {
+            1: { name: "support.function.builtin.tiramisu" },
+          },
+        },
+        {
+          // Custom/user functions
+          match: "\\b([a-zA-Z_][a-zA-Z0-9_]*)\\s*(?=\\{)",
+          captures: {
+            1: { name: "entity.name.function.tiramisu" },
+          },
+        },
+        {
+          // Named parameter keys
+          match: "\\b([a-zA-Z_][a-zA-Z0-9_]*)\\s*(?==)",
+          captures: {
+            1: { name: "variable.parameter.tiramisu" },
+          },
+        },
+        {
+          name: "punctuation.section.braces.tiramisu",
+          match: "[{}]",
+        },
+        {
+          name: "punctuation.section.brackets.tiramisu",
+          match: "[\\[\\]]",
+        },
+        {
+          name: "punctuation.separator.comma.tiramisu",
+          match: ",",
+        },
+        {
+          name: "keyword.operator.assignment.tiramisu",
+          match: "=",
+        },
+      ],
+    },
+  },
+}

package/src/types.ts

@@ -0,0 +1,71 @@
+import type { DocMeta, Heading } from "@tiramisu-docs/core"
+import type { SvelteComponent } from "svelte"
+
+export interface SidebarItem {
+  type: "item"
+  title: string
+  slug: string
+  order: number
+  icon?: string
+}
+
+export interface SidebarSubgroup {
+  type: "subgroup"
+  key: string
+  label: string
+  slug?: string
+  items: SidebarEntry[]
+  order: number
+  icon?: string
+}
+
+export type SidebarEntry = SidebarItem | SidebarSubgroup
+
+export interface SidebarGroup {
+  label: string
+  items: SidebarEntry[]
+  icon?: string
+}
+
+export interface VirtualDoc {
+  slug: string
+  meta: DocMeta
+  headings: Heading[]
+  lastEdited?: string
+}
+
+export interface SearchIndexEntry {
+  id: string
+  title: string
+  group: string
+  slug: string
+  headings: string
+  text: string
+}
+
+export interface ResolvedSection {
+  label: string
+  path?: string
+  href?: string
+  icon?: string
+  children?: ResolvedSection[]
+  sidebar?: SidebarGroup[]
+}
+
+export interface LocaleData {
+  sections?: ResolvedSection[]
+  sidebar: SidebarGroup[]
+  docs: VirtualDoc[]
+  searchIndex: SearchIndexEntry[]
+  docImports: Record<string, () => Promise<{ default: typeof SvelteComponent }>>
+}
+
+export interface VirtualModule {
+  docs: VirtualDoc[]
+  sidebar: SidebarGroup[]
+  sections?: ResolvedSection[]
+  docImports: Record<string, () => Promise<{ default: typeof SvelteComponent }>>
+  searchIndex: SearchIndexEntry[]
+  locales?: Record<string, LocaleData>
+  defaultLocale?: string
+}

package/src/virtual.d.ts

@@ -0,0 +1,11 @@
+declare module "virtual:tiramisu-docs" {
+  import type { VirtualDoc, SidebarGroup, ResolvedSection, SearchIndexEntry, LocaleData } from "./types"
+
+  export const docs: VirtualDoc[]
+  export const sidebar: SidebarGroup[]
+  export const sections: ResolvedSection[] | undefined
+  export const docImports: Record<string, () => Promise<{ default: any }>>
+  export const searchIndex: SearchIndexEntry[]
+  export const locales: Record<string, LocaleData> | undefined
+  export const defaultLocale: string | undefined
+}