svelte-docsmith 0.7.0 → 0.9.0

package/dist/generate/feed.js

@@ -0,0 +1,80 @@
+const escapeXml = (s) => s.replace(/[&<>'"]/g, (c) => {
+    switch (c) {
+        case '&':
+            return '&amp;';
+        case '<':
+            return '&lt;';
+        case '>':
+            return '&gt;';
+        case "'":
+            return '&apos;';
+        default:
+            return '&quot;';
+    }
+});
+/** A release's entries flattened to plain text, grouped by kind. */
+function summarise(release) {
+    return release.groups
+        .map((group) => `${group.kind}\n\n${group.items.map((item) => `- ${item}`).join('\n\n')}`)
+        .join('\n\n');
+}
+/**
+ * Build an Atom feed body from parsed changelog releases. Framework-agnostic:
+ * wire it into a SvelteKit `src/routes/changelog.xml/+server.ts` over the
+ * generated `svelte-docsmith/changelog` index.
+ *
+ * ```ts
+ * import { releases } from 'svelte-docsmith/changelog';
+ * import { generateFeed } from 'svelte-docsmith';
+ *
+ * export const prerender = true;
+ * export function GET() {
+ *   const body = generateFeed(releases, {
+ *     url: 'https://my-docs.dev',
+ *     title: 'My Library'
+ *   });
+ *   return new Response(body, { headers: { 'content-type': 'application/atom+xml' } });
+ * }
+ * ```
+ *
+ * Atom rather than RSS because it requires an unambiguous per-entry id and
+ * update timestamp, which is exactly what a version and its release date give.
+ */
+export function generateFeed(releases, site) {
+    const origin = site.url.replace(/\/$/, '');
+    const path = site.path ?? '/changelog';
+    const feedUrl = `${origin}${path}.xml`;
+    // A feed needs an updated timestamp; fall back to now when no release
+    // carries a date, so the document stays valid.
+    const updated = releases.find((r) => r.date)?.date ?? new Date().toISOString();
+    const entries = releases
+        .map((release) => {
+        const link = release.path
+            ? `${origin}${release.path}`
+            : `${origin}${path}#${release.version}`;
+        return [
+            '\t<entry>',
+            `\t\t<title>${escapeXml(release.version)}</title>`,
+            `\t\t<id>${escapeXml(link)}</id>`,
+            `\t\t<link href="${escapeXml(link)}" />`,
+            `\t\t<updated>${escapeXml(release.date ?? updated)}</updated>`,
+            `\t\t<content type="text">${escapeXml(summarise(release))}</content>`,
+            '\t</entry>'
+        ].join('\n');
+    })
+        .join('\n');
+    return [
+        '<?xml version="1.0" encoding="utf-8"?>',
+        '<feed xmlns="http://www.w3.org/2005/Atom">',
+        `\t<title>${escapeXml(site.title)}</title>`,
+        site.description ? `\t<subtitle>${escapeXml(site.description)}</subtitle>` : '',
+        `\t<id>${escapeXml(feedUrl)}</id>`,
+        `\t<link href="${escapeXml(origin + path)}" />`,
+        `\t<link rel="self" href="${escapeXml(feedUrl)}" />`,
+        `\t<updated>${escapeXml(updated)}</updated>`,
+        entries,
+        '</feed>'
+    ]
+        .filter(Boolean)
+        .join('\n');
+}

package/dist/index.d.ts

@@ -18,7 +18,15 @@ export { default as FileTree } from './components/docs/file-tree.svelte';
 export { default as FileTreeItem } from './components/docs/file-tree-item.svelte';
 export { default as PropsTable } from './components/docs/props-table.svelte';
 export { default as Prop } from './components/docs/prop.svelte';
+export { default as Hero } from './components/landing/hero.svelte';
+export { default as FeatureGrid } from './components/landing/feature-grid.svelte';
+export { default as Feature } from './components/landing/feature.svelte';
+export { default as CTA } from './components/landing/cta.svelte';
+export { default as Action } from './components/landing/action.svelte';
 export { defineConfig, type DocsmithConfig, type DocsContentItem, type SearchDoc, type LlmsDoc } from './core/index.js';
 export { createSearchEngine, type SearchEngine, type SearchResult } from './search/create-search.js';
 export { generateSitemap, type SitemapEntry } from './generate/sitemap.js';
 export { generateLlmsTxt, generateLlmsFullTxt, type LlmsSite } from './generate/llms.js';
+export { default as Changelog } from './components/changelog/changelog.svelte';
+export type { ChangelogRelease, ChangelogGroup } from './core/changelog.js';
+export { generateFeed, type FeedSite } from './generate/feed.js';

package/dist/index.js

@@ -23,6 +23,12 @@ export { default as FileTree } from './components/docs/file-tree.svelte';
 export { default as FileTreeItem } from './components/docs/file-tree-item.svelte';
 export { default as PropsTable } from './components/docs/props-table.svelte';
 export { default as Prop } from './components/docs/prop.svelte';
+// Landing page sections (for the marketing page in front of your docs)
+export { default as Hero } from './components/landing/hero.svelte';
+export { default as FeatureGrid } from './components/landing/feature-grid.svelte';
+export { default as Feature } from './components/landing/feature.svelte';
+export { default as CTA } from './components/landing/cta.svelte';
+export { default as Action } from './components/landing/action.svelte';
 // Config
 export { defineConfig } from './core/index.js';
 // Search engine (framework-agnostic; for building a custom search UI over the
@@ -33,3 +39,6 @@ export { generateSitemap } from './generate/sitemap.js';
 // llms.txt (framework-agnostic; wire into `llms.txt/+server.ts` and
 // `llms-full.txt/+server.ts` over the generated `svelte-docsmith/llms` index)
 export { generateLlmsTxt, generateLlmsFullTxt } from './generate/llms.js';
+// Changelog (the generated `svelte-docsmith/changelog` index, plus its feed)
+export { default as Changelog } from './components/changelog/changelog.svelte';
+export { generateFeed } from './generate/feed.js';

package/dist/theme.css

@@ -224,3 +224,35 @@ html.dark .shiki span {
 html.dark .shiki {
 	background-color: var(--shiki-dark-bg, transparent) !important;
 }
+
+/*
+ * Mermaid loading skeleton. Global (not scoped) because it is rendered both by
+ * the server-side placeholder the preprocessor emits and by the client
+ * component before the diagram is ready — sharing one rule keeps their height
+ * identical, so the space is reserved from first paint and the diagram no longer
+ * shifts the page in as it loads.
+ */
+.docsmith-mermaid-skeleton {
+	margin: 1.5rem 0;
+	min-height: 8rem;
+	border-radius: var(--radius, 0.75rem);
+	border: 1px solid var(--border);
+	background: color-mix(in oklch, var(--muted) 45%, transparent);
+	animation: docsmith-mermaid-pulse 1.6s ease-in-out infinite;
+}
+
+@keyframes docsmith-mermaid-pulse {
+	0%,
+	100% {
+		opacity: 0.55;
+	}
+	50% {
+		opacity: 1;
+	}
+}
+
+@media (prefers-reduced-motion: reduce) {
+	.docsmith-mermaid-skeleton {
+		animation: none;
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-docsmith",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "A framework for building beautiful documentation sites with Svelte.",
   "author": {
     "name": "George Daskalakis",
@@ -43,6 +43,15 @@
       "types": "./dist/fallbacks/llms.d.ts",
       "default": "./dist/fallbacks/llms.js"
     },
+    "./changelog": {
+      "types": "./dist/fallbacks/changelog.d.ts",
+      "default": "./dist/fallbacks/changelog.js"
+    },
+    "./mermaid": {
+      "types": "./dist/components/docs/mermaid.svelte.d.ts",
+      "svelte": "./dist/components/docs/mermaid.svelte",
+      "default": "./dist/components/docs/mermaid.svelte"
+    },
     "./theme.css": "./dist/theme.css",
     "./themes/*.css": "./dist/themes/*.css",
     "./package.json": "./package.json"
@@ -57,11 +66,18 @@
   "license": "MIT",
   "peerDependencies": {
     "@sveltejs/kit": "^2.16.0",
+    "mermaid": "^10.0.0 || ^11.0.0",
     "svelte": "^5.0.0",
     "tailwindcss": "^4.0.0"
   },
+  "peerDependenciesMeta": {
+    "mermaid": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@internationalized/date": "^3.12.2",
+    "@shikijs/twoslash": "3.23.0",
     "@sveltejs/adapter-auto": "^7.0.1",
     "@sveltejs/adapter-vercel": "^6.3.4",
     "@sveltejs/kit": "^2.69.1",
@@ -73,12 +89,14 @@
     "@types/node": "^22",
     "@vitest/coverage-v8": "4.1.9",
     "jsdom": "^26.0.0",
+    "mermaid": "^11.16.0",
     "publint": "^0.3.2",
     "shadcn-svelte": "^1.3.0",
     "svelte": "^5.56.4",
     "svelte-check": "^4.7.1",
     "tailwindcss": "^4.3.2",
-    "typescript": "^5.0.0",
+    "twoslash-svelte": "0.3.9",
+    "typescript": "^5.8.3",
     "vite": "^8.1.3",
     "vitest": "^4.1.9"
   },
@@ -94,6 +112,7 @@
     "flexsearch": "^0.8.212",
     "github-slugger": "^2.0.0",
     "js-yaml": "^4.1.0",
+    "marked": "^18.0.6",
     "mdsvex": "^0.12.3",
     "mode-watcher": "^1.0.2",
     "rehype-slug": "^6.0.0",