svedocs-cli 0.1.0-beta.1

package/dist/create-svedocs.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/create-svedocs.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import {
+  runCreateSvedocsCli
+} from "./chunk-QD6TB2KV.js";
+
+// src/create-svedocs.ts
+var result = await runCreateSvedocsCli(process.argv.slice(2));
+var output = result.ok ? console.log : console.error;
+output(result.message);
+if (!result.ok) {
+  process.exitCode = 1;
+}

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+interface CliResult {
+    command: string;
+    args: string[];
+    ok: boolean;
+    message: string;
+}
+
+type PackageManagerName = 'pnpm' | 'npm' | 'yarn' | 'bun';
+
+interface CreateSvedocsRuntime {
+    env?: NodeJS.ProcessEnv;
+    readPackageManagerVersion?: (name: PackageManagerName) => Promise<string | undefined>;
+}
+declare function renderCreateSvedocsHelp(): string;
+declare function runCreateSvedocsCli(args: string[], runtime?: CreateSvedocsRuntime): Promise<CliResult>;
+
+declare function renderSvedocsHelp(): string;
+declare function runSvedocsCli(args: string[]): Promise<CliResult>;
+
+export { type CliResult, type CreateSvedocsRuntime, renderCreateSvedocsHelp, renderSvedocsHelp, runCreateSvedocsCli, runSvedocsCli };

package/dist/index.js

@@ -0,0 +1,12 @@
+import {
+  renderCreateSvedocsHelp,
+  renderSvedocsHelp,
+  runCreateSvedocsCli,
+  runSvedocsCli
+} from "./chunk-QD6TB2KV.js";
+export {
+  renderCreateSvedocsHelp,
+  renderSvedocsHelp,
+  runCreateSvedocsCli,
+  runSvedocsCli
+};

package/dist/svedocs.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/svedocs.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import {
+  runSvedocsCli
+} from "./chunk-QD6TB2KV.js";
+
+// src/svedocs.ts
+var result = await runSvedocsCli(process.argv.slice(2));
+var output = result.ok ? console.log : console.error;
+output(result.message);
+if (!result.ok) {
+  process.exitCode = 1;
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "svedocs-cli",
+  "version": "0.1.0-beta.1",
+  "description": "CLI for the svedocs documentation framework.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/backrunner/svedocs.git",
+    "directory": "packages/cli"
+  },
+  "bugs": {
+    "url": "https://github.com/backrunner/svedocs/issues"
+  },
+  "homepage": "https://github.com/backrunner/svedocs/tree/main/packages/cli#readme",
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "bin": {
+    "svedocs": "./dist/svedocs.js",
+    "create-svedocs": "./dist/create-svedocs.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "commander": "14.0.3",
+    "svedocs": "0.1.0-beta.1"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts src/svedocs.ts src/create-svedocs.ts --format esm --dts --clean",
+    "test": "vitest run",
+    "check": "tsc -p tsconfig.json --noEmit",
+    "lint": "tsc -p tsconfig.json --noEmit",
+    "pack:dry-run": "pnpm pack --dry-run",
+    "dev": "tsup src/index.ts src/svedocs.ts src/create-svedocs.ts --format esm --dts --watch"
+  }
+}

package/templates/cloudflare/.dev.vars.example

@@ -0,0 +1,14 @@
+SVEDOCS_AI_SEARCH_INSTANCE=svedocs
+
+# Optional hosted search providers. Keep real keys in .dev.vars or platform secrets.
+ALGOLIA_APP_ID=
+ALGOLIA_SEARCH_KEY=
+ALGOLIA_INDEX_NAME=docs
+TYPESENSE_HOST=
+TYPESENSE_SEARCH_KEY=
+TYPESENSE_COLLECTION=docs
+
+# Optional OpenAI-compatible Ask AI provider.
+OPENAI_COMPATIBLE_API_KEY=
+OPENAI_COMPATIBLE_BASE_URL=https://api.openai.com/v1
+OPENAI_COMPATIBLE_MODEL=gpt-4.1-mini

package/templates/cloudflare/README.md

@@ -0,0 +1,13 @@
+# svedocs Cloudflare
+
+Cloudflare-first svedocs starter.
+
+```sh
+pnpm install
+pnpm dev
+pnpm build
+pnpm build:ssg
+pnpm preview:cloudflare
+```
+
+The default build uses `@sveltejs/adapter-cloudflare` with local remote bindings disabled, so builds do not require a Cloudflare account. Static SSG builds are available with `pnpm build:ssg` or `svedocs build --mode static`; `pnpm build:spa` adds a static fallback for hosts that need one.

package/templates/cloudflare/content/docs/index.md

@@ -0,0 +1,20 @@
+---
+title: Introduction
+description: Build and deploy svedocs on Cloudflare.
+---
+
+# Introduction
+
+This project uses the Cloudflare adapter by default.
+
+## Build
+
+```sh
+pnpm build
+```
+
+## Preview
+
+```sh
+pnpm preview:cloudflare
+```

package/templates/cloudflare/content/pages/index.md

@@ -0,0 +1,9 @@
+---
+title: Cloudflare docs
+description: Edge-first docs powered by svedocs.
+layout: home
+---
+
+## Edge-first
+
+This starter is ready for Cloudflare Pages and Workers bindings.

package/templates/cloudflare/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "svedocs-cloudflare",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "svedocs dev",
+    "build": "svedocs build",
+    "build:edge": "svedocs build --mode edge",
+    "build:static": "svedocs build --mode static",
+    "build:ssg": "svedocs ssg",
+    "build:spa": "svedocs build --mode spa",
+    "preview": "svedocs preview",
+    "preview:cloudflare": "wrangler pages dev .svelte-kit/cloudflare",
+    "deploy": "wrangler pages deploy .svelte-kit/cloudflare",
+    "check": "svelte-kit sync && tsc -p tsconfig.json --noEmit"
+  },
+  "dependencies": {
+    "@sveltejs/adapter-cloudflare": "^7.2.8",
+    "@sveltejs/adapter-static": "^3.0.10",
+    "@sveltejs/kit": "^2.60.1",
+    "@sveltejs/vite-plugin-svelte": "^7.1.2",
+    "@tailwindcss/vite": "^4.3.0",
+    "svelte": "^5.55.7",
+    "svedocs": "latest",
+    "tailwindcss": "^4.3.0",
+    "vite": "^8.0.13",
+    "wrangler": "^4.92.0"
+  },
+  "devDependencies": {
+    "svedocs-cli": "latest",
+    "@types/node": "^25.8.0",
+    "typescript": "^6.0.3"
+  }
+}

package/templates/cloudflare/src/app.cloudflare.d.ts

@@ -0,0 +1,21 @@
+declare namespace App {
+  interface Platform {
+    env: {
+      SVEDOCS_AI_SEARCH?: import('svedocs/search').CloudflareAiSearchInstance;
+      AI?: import('svedocs/ai').CloudflareWorkersAiBinding;
+      ALGOLIA_APP_ID?: string;
+      ALGOLIA_SEARCH_KEY?: string;
+      ALGOLIA_INDEX_NAME?: string;
+      TYPESENSE_HOST?: string;
+      TYPESENSE_SEARCH_KEY?: string;
+      TYPESENSE_COLLECTION?: string;
+      OPENAI_COMPATIBLE_API_KEY?: string;
+      OPENAI_COMPATIBLE_BASE_URL?: string;
+      OPENAI_COMPATIBLE_MODEL?: string;
+    };
+    context: {
+      waitUntil(promise: Promise<unknown>): void;
+    };
+    caches: CacheStorage;
+  }
+}

package/templates/cloudflare/src/app.d.ts

@@ -0,0 +1,35 @@
+declare module 'virtual:svedocs/config' {
+  import type { SvedocsResolvedConfig } from 'svedocs/core';
+  const config: SvedocsResolvedConfig;
+  export default config;
+}
+
+declare module 'virtual:svedocs/pages' {
+  import type { SvedocsPage } from 'svedocs/core';
+  const pages: SvedocsPage[];
+  export default pages;
+}
+
+declare module 'virtual:svedocs/tree' {
+  import type { SvedocsTreeItem } from 'svedocs/core';
+  const tree: SvedocsTreeItem[];
+  export default tree;
+}
+
+declare module 'virtual:svedocs/search' {
+  import type { SvedocsSearchRecord } from 'svedocs/core';
+  const records: SvedocsSearchRecord[];
+  export default records;
+}
+
+declare module 'virtual:svedocs/components' {
+  import type { Component } from 'svelte';
+  const components: Record<string, Component>;
+  export default components;
+}
+
+declare module 'virtual:svedocs/layouts' {
+  import type { Component } from 'svelte';
+  const layouts: Record<string, Component>;
+  export default layouts;
+}

package/templates/cloudflare/src/app.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="icon" href="/favicon.svg" />
+    %sveltekit.head%
+  </head>
+  <body data-sveltekit-preload-data="hover">
+    <div style="display: contents">%sveltekit.body%</div>
+  </body>
+</html>

package/templates/cloudflare/src/lib/server/env.ts

@@ -0,0 +1,3 @@
+export function getRuntimeEnv(platformEnv: Record<string, unknown> | undefined): Record<string, unknown> {
+  return platformEnv ?? (typeof process !== 'undefined' ? process.env : {});
+}

package/templates/cloudflare/src/routes/+layout.svelte

@@ -0,0 +1,5 @@
+<script lang="ts">
+  import 'svedocs/theme/styles.css';
+</script>
+
+<slot />

package/templates/cloudflare/src/routes/+layout.ts

@@ -0,0 +1,3 @@
+import { svedocsSsr } from 'svedocs/cloudflare';
+
+export const ssr = svedocsSsr();

package/templates/cloudflare/src/routes/+page.svelte

@@ -0,0 +1,8 @@
+<script lang="ts">
+  import { DocsApp } from 'svedocs/theme';
+  import components from 'virtual:svedocs/components';
+  import layouts from 'virtual:svedocs/layouts';
+  export let data;
+</script>
+
+<DocsApp page={data.page} pages={data.pages} tree={data.tree} search={data.search} config={data.config} {components} {layouts} />

package/templates/cloudflare/src/routes/+page.ts

@@ -0,0 +1,12 @@
+import config from 'virtual:svedocs/config';
+import pages from 'virtual:svedocs/pages';
+import search from 'virtual:svedocs/search';
+import tree from 'virtual:svedocs/tree';
+import { svedocsPagePrerender } from 'svedocs/cloudflare';
+import type { PageLoad } from './$types';
+
+export const prerender = svedocsPagePrerender();
+
+export const load: PageLoad = () => {
+  return { page: pages.find((page) => page.routePath === '/'), pages, search, tree, config };
+};

package/templates/cloudflare/src/routes/[...path]/+page.svelte

@@ -0,0 +1,8 @@
+<script lang="ts">
+  import { DocsApp } from 'svedocs/theme';
+  import components from 'virtual:svedocs/components';
+  import layouts from 'virtual:svedocs/layouts';
+  export let data;
+</script>
+
+<DocsApp page={data.page} pages={data.pages} tree={data.tree} search={data.search} config={data.config} {components} {layouts} />

package/templates/cloudflare/src/routes/[...path]/+page.ts

@@ -0,0 +1,22 @@
+import { error } from '@sveltejs/kit';
+import config from 'virtual:svedocs/config';
+import pages from 'virtual:svedocs/pages';
+import search from 'virtual:svedocs/search';
+import tree from 'virtual:svedocs/tree';
+import { svedocsPagePrerender } from 'svedocs/cloudflare';
+import type { PageLoad } from './$types';
+
+export const prerender = svedocsPagePrerender();
+
+export function entries() {
+  return pages
+    .filter((page) => page.routePath !== '/')
+    .map((page) => ({ path: page.routePath.replace(/^\//, '') }));
+}
+
+export const load: PageLoad = ({ params }) => {
+  const routePath = `/${params.path ?? ''}`.replace(/\/$/, '') || '/';
+  const page = pages.find((item) => item.routePath === routePath);
+  if (!page) error(404, `No page found for ${routePath}`);
+  return { page, pages, search, tree, config };
+};

package/templates/cloudflare/src/routes/api/ask/+server.ts

@@ -0,0 +1,15 @@
+import { createConfiguredAskResponse, createMemoryRateLimiter } from 'svedocs/ai';
+import { getRuntimeEnv } from '$lib/server/env';
+import config from 'virtual:svedocs/config';
+import records from 'virtual:svedocs/search';
+import type { RequestHandler } from './$types';
+
+export const prerender = false;
+const rateLimiter = createMemoryRateLimiter({ windowMs: 60_000, max: 30 });
+
+export const POST: RequestHandler = ({ platform, request }) => {
+  return createConfiguredAskResponse(config, records, request, {
+    env: getRuntimeEnv(platform?.env),
+    rateLimiter
+  });
+};

package/templates/cloudflare/src/routes/api/search/+server.ts

@@ -0,0 +1,13 @@
+import { createConfiguredSearchResponse } from 'svedocs/search';
+import { getRuntimeEnv } from '$lib/server/env';
+import config from 'virtual:svedocs/config';
+import records from 'virtual:svedocs/search';
+import type { RequestHandler } from './$types';
+
+export const prerender = false;
+
+export const GET: RequestHandler = ({ platform, request }) => {
+  return createConfiguredSearchResponse(config, records, request, {
+    env: getRuntimeEnv(platform?.env)
+  });
+};

package/templates/cloudflare/src/routes/og/[...path]/+server.ts

@@ -0,0 +1,26 @@
+import { error } from '@sveltejs/kit';
+import { createConfiguredOgImageFormat, createConfiguredOgImageRenderer, createPageOgImageEntries, createPageOgImagePath, createPageOgImageResponse } from 'svedocs/og';
+import config from 'virtual:svedocs/config';
+import pages from 'virtual:svedocs/pages';
+import type { RequestHandler } from './$types';
+
+export const prerender = true;
+
+const format = createConfiguredOgImageFormat(config);
+
+export function entries() {
+  return createPageOgImageEntries(pages, format);
+}
+
+export const GET: RequestHandler = async ({ params }) => {
+  const requestPath = `/og/${params.path}`;
+  const page = pages.find((candidate) => createPageOgImagePath(candidate, format) === requestPath);
+  if (!page) error(404, `No OG image found for ${requestPath}`);
+  return createPageOgImageResponse(config, page, {
+    format,
+    renderer: createConfiguredOgImageRenderer(config),
+    ...(config.seo.ogImage !== false && typeof config.seo.ogImage.template === 'function'
+      ? { template: config.seo.ogImage.template }
+      : {})
+  });
+};

package/templates/cloudflare/src/routes/robots.txt/+server.ts

@@ -0,0 +1,12 @@
+import { createRobotsTxt } from 'svedocs/og';
+import config from 'virtual:svedocs/config';
+
+export const prerender = true;
+
+export function GET() {
+  return new Response(createRobotsTxt(config), {
+    headers: {
+      'content-type': 'text/plain; charset=utf-8'
+    }
+  });
+}

package/templates/cloudflare/src/routes/sitemap.xml/+server.ts

@@ -0,0 +1,13 @@
+import { createSitemapXml } from 'svedocs/og';
+import config from 'virtual:svedocs/config';
+import pages from 'virtual:svedocs/pages';
+
+export const prerender = true;
+
+export function GET() {
+  return new Response(createSitemapXml(config, pages), {
+    headers: {
+      'content-type': 'application/xml; charset=utf-8'
+    }
+  });
+}

package/templates/cloudflare/static/favicon.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" viewBox="0 0 64 64">
+  <rect width="64" height="64" fill="#11130f"/>
+  <rect x="12" y="12" width="16" height="16" fill="#50d6b3"/>
+  <rect x="28" y="28" width="16" height="16" fill="#ff8a66"/>
+  <rect x="12" y="44" width="16" height="8" fill="#f4f1e8"/>
+</svg>

package/templates/cloudflare/svedocs.config.ts

@@ -0,0 +1,26 @@
+import { defineConfig } from 'svedocs/config';
+
+export default defineConfig({
+  site: {
+    name: 'svedocs cloudflare',
+    title: 'svedocs cloudflare',
+    description: 'Edge-first documentation powered by svedocs and Cloudflare Pages.'
+  },
+  search: {
+    enabled: true,
+    provider: 'cloudflare-ai-search'
+  },
+  ai: {
+    enabled: true,
+    provider: 'cloudflare-ai-search'
+  },
+  source: {
+    editBaseUrl: 'https://github.com/acme/my-docs/edit/main'
+  },
+  cloudflare: {
+    aiSearch: {
+      binding: 'SVEDOCS_AI_SEARCH',
+      instanceName: 'svedocs'
+    }
+  }
+});

package/templates/cloudflare/svelte.config.js

@@ -0,0 +1,18 @@
+import adapterCloudflare from '@sveltejs/adapter-cloudflare';
+import adapterStatic from '@sveltejs/adapter-static';
+import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
+import { svedocsPreprocess, svedocsSvelteExtensions } from 'svedocs/svelte';
+
+const mode = process.env.SVEDOCS_BUILD_MODE ?? 'edge';
+const adapter =
+  mode === 'edge'
+    ? adapterCloudflare({ platformProxy: { remoteBindings: false } })
+    : adapterStatic(mode === 'spa' ? { fallback: '200.html' } : { strict: false });
+
+export default {
+  extensions: svedocsSvelteExtensions,
+  preprocess: [vitePreprocess(), svedocsPreprocess()],
+  kit: {
+    adapter
+  }
+};

package/templates/cloudflare/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./.svelte-kit/tsconfig.json",
+  "compilerOptions": {
+    "strict": true,
+    "moduleResolution": "bundler"
+  }
+}

package/templates/cloudflare/vite.config.ts

@@ -0,0 +1,9 @@
+import tailwindcss from '@tailwindcss/vite';
+import { sveltekit } from '@sveltejs/kit/vite';
+import { defineConfig } from 'vite';
+import { svedocs } from 'svedocs/vite';
+import svedocsConfig from './svedocs.config';
+
+export default defineConfig({
+  plugins: [svedocs({ config: svedocsConfig }), tailwindcss(), sveltekit()]
+});

package/templates/cloudflare/wrangler.toml

@@ -0,0 +1,7 @@
+name = "svedocs-cloudflare"
+compatibility_date = "2026-05-18"
+pages_build_output_dir = ".svelte-kit/cloudflare"
+
+[[ai_search]]
+binding = "SVEDOCS_AI_SEARCH"
+instance_name = "svedocs"

package/templates/docs/README.md

@@ -0,0 +1,12 @@
+# svedocs docs
+
+Documentation starter powered by svedocs.
+
+```sh
+pnpm install
+pnpm dev
+pnpm build
+pnpm build:ssg
+```
+
+`pnpm build` targets Cloudflare edge SSR by default with local remote bindings disabled, so builds do not require a Cloudflare account. Use `pnpm build:ssg` for static output or `pnpm build:spa` for prerendered pages plus a static fallback.

package/templates/docs/content/docs/index.md

@@ -0,0 +1,14 @@
+---
+title: Introduction
+description: Your first svedocs page.
+---
+
+# Introduction
+
+Welcome to svedocs.
+
+## Next steps
+
+- Configure `svedocs.config.ts`.
+- Add pages under `content/docs`.
+- Deploy to Cloudflare or build statically.

package/templates/docs/content/pages/index.md

@@ -0,0 +1,9 @@
+---
+title: My docs
+description: A new documentation site powered by svedocs.
+layout: home
+---
+
+## Start writing
+
+Edit `content/docs/index.md` to begin.

package/templates/docs/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "svedocs-app",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "svedocs dev",
+    "build": "svedocs build",
+    "build:edge": "svedocs build --mode edge",
+    "build:static": "svedocs build --mode static",
+    "build:ssg": "svedocs ssg",
+    "build:spa": "svedocs build --mode spa",
+    "preview": "svedocs preview",
+    "check": "svedocs check"
+  },
+  "dependencies": {
+    "@sveltejs/adapter-cloudflare": "^7.2.8",
+    "@sveltejs/adapter-static": "^3.0.10",
+    "@sveltejs/kit": "^2.60.1",
+    "@sveltejs/vite-plugin-svelte": "^7.1.2",
+    "@tailwindcss/vite": "^4.3.0",
+    "svelte": "^5.55.7",
+    "svedocs": "latest",
+    "tailwindcss": "^4.3.0",
+    "vite": "^8.0.13"
+  },
+  "devDependencies": {
+    "svedocs-cli": "latest",
+    "@types/node": "^25.8.0",
+    "typescript": "^6.0.3"
+  }
+}

package/templates/docs/src/app.d.ts

@@ -0,0 +1,35 @@
+declare module 'virtual:svedocs/config' {
+  import type { SvedocsResolvedConfig } from 'svedocs/core';
+  const config: SvedocsResolvedConfig;
+  export default config;
+}
+
+declare module 'virtual:svedocs/pages' {
+  import type { SvedocsPage } from 'svedocs/core';
+  const pages: SvedocsPage[];
+  export default pages;
+}
+
+declare module 'virtual:svedocs/tree' {
+  import type { SvedocsTreeItem } from 'svedocs/core';
+  const tree: SvedocsTreeItem[];
+  export default tree;
+}
+
+declare module 'virtual:svedocs/search' {
+  import type { SvedocsSearchRecord } from 'svedocs/core';
+  const records: SvedocsSearchRecord[];
+  export default records;
+}
+
+declare module 'virtual:svedocs/components' {
+  import type { Component } from 'svelte';
+  const components: Record<string, Component>;
+  export default components;
+}
+
+declare module 'virtual:svedocs/layouts' {
+  import type { Component } from 'svelte';
+  const layouts: Record<string, Component>;
+  export default layouts;
+}

package/templates/docs/src/app.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="icon" href="/favicon.svg" />
+    %sveltekit.head%
+  </head>
+  <body data-sveltekit-preload-data="hover">
+    <div style="display: contents">%sveltekit.body%</div>
+  </body>
+</html>