svedocs-cli 0.1.0-beta.1

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

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

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

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

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

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

package/templates/docs/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/docs/src/routes/+page.ts

@@ -0,0 +1,12 @@
+import pages from 'virtual:svedocs/pages';
+import search from 'virtual:svedocs/search';
+import tree from 'virtual:svedocs/tree';
+import config from 'virtual:svedocs/config';
+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/docs/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/docs/src/routes/[...path]/+page.ts

@@ -0,0 +1,22 @@
+import { error } from '@sveltejs/kit';
+import pages from 'virtual:svedocs/pages';
+import search from 'virtual:svedocs/search';
+import tree from 'virtual:svedocs/tree';
+import config from 'virtual:svedocs/config';
+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/docs/src/routes/api/ask/+server.ts

@@ -0,0 +1,16 @@
+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 = ({ request }) => {
+  return createConfiguredAskResponse(config, records, request, {
+    env: getRuntimeEnv(),
+    rateLimiter
+  });
+};

package/templates/docs/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 = ({ request }) => {
+  return createConfiguredSearchResponse(config, records, request, {
+    env: getRuntimeEnv()
+  });
+};

package/templates/docs/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/docs/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/docs/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/docs/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/docs/svedocs.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'svedocs/config';
+
+export default defineConfig({
+  site: {
+    name: 'My docs',
+    title: 'My docs',
+    description: 'Documentation built with svedocs'
+  },
+  source: {
+    editBaseUrl: 'https://github.com/acme/my-docs/edit/main'
+  }
+});

package/templates/docs/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/docs/tsconfig.json

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

package/templates/docs/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/minimal/README.md

@@ -0,0 +1,12 @@
+# svedocs minimal
+
+Small SvelteKit docs app powered by svedocs.
+
+```sh
+pnpm install
+pnpm dev
+pnpm build
+pnpm build:ssg
+```
+
+`pnpm build` uses 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/minimal/content/docs/index.md

@@ -0,0 +1,8 @@
+---
+title: Introduction
+description: The first page in your minimal docs.
+---
+
+# Introduction
+
+This is a minimal svedocs project.

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

@@ -0,0 +1,9 @@
+---
+title: Minimal docs
+description: A small svedocs starter.
+layout: home
+---
+
+## Start
+
+Edit `content/docs/index.md` to write your docs.

package/templates/minimal/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "svedocs-minimal",
+  "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/minimal/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/minimal/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/minimal/src/routes/+layout.svelte

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

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

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

package/templates/minimal/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/minimal/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/minimal/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/minimal/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/minimal/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/minimal/svedocs.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'svedocs/config';
+
+export default defineConfig({
+  site: {
+    name: 'svedocs minimal',
+    title: 'svedocs minimal',
+    description: 'A minimal documentation site powered by svedocs.'
+  },
+  ai: false
+});

package/templates/minimal/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/minimal/tsconfig.json

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

package/templates/minimal/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()]
+});