create-svelte-docsmith 0.1.1 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-svelte-docsmith",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Scaffold a documentation site powered by Svelte DocSmith.",
   "type": "module",
   "bin": {

package/template/package.json

@@ -10,7 +10,7 @@
 		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
 	},
 	"dependencies": {
-		"svelte-docsmith": "^0.4.0"
+		"svelte-docsmith": "^0.5.1"
 	},
 	"devDependencies": {
 		"@sveltejs/adapter-auto": "^7.0.1",

package/template/src/lib/site-config.ts

@@ -6,7 +6,11 @@ export const siteConfig: DocsmithConfig = {
 	title: '{{SITE_TITLE}}',
 	// github: 'https://github.com/you/your-library',
 	// description: 'A short tagline, used as the default meta description.',
+	// Set `url` to your deployed origin so the sitemap, llms.txt, and social
+	// tags emit absolute links.
 	// url: 'https://your-docs.dev',
+	// Base URL for the "Edit this page" link (points at your repo's docs dir).
+	// editUrl: 'https://github.com/you/your-library/edit/main',
 	nav: [{ label: 'Docs', href: '/docs/introduction' }],
 	footer: {
 		copyright: `© ${new Date().getFullYear()} {{SITE_TITLE}}`

package/template/src/routes/[...slug].md/+server.ts

@@ -0,0 +1,17 @@
+import { docs } from 'svelte-docsmith/llms';
+import { error } from '@sveltejs/kit';
+import type { EntryGenerator, RequestHandler } from './$types';
+
+export const prerender = true;
+
+// Enumerate every page so the `.md` twins prerender even if nothing links to them.
+export const entries: EntryGenerator = () =>
+	docs.map((doc) => ({ slug: doc.path.replace(/^\//, '') }));
+
+export const GET: RequestHandler = ({ params }) => {
+	const doc = docs.find((d) => d.path === `/${params.slug}`);
+	if (!doc) error(404, 'Not found');
+	return new Response(doc.content, {
+		headers: { 'content-type': 'text/markdown; charset=utf-8' }
+	});
+};

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

@@ -12,6 +12,7 @@
 	content={docs}
 	search={() => import('svelte-docsmith/search').then((m) => m.docs)}
 	pattern
+	copyPage
 >
 	{@render children()}
 </DocsShell>

package/template/src/routes/llms-full.txt/+server.ts

@@ -0,0 +1,13 @@
+import { docs } from 'svelte-docsmith/llms';
+import { generateLlmsFullTxt } from 'svelte-docsmith';
+import { siteConfig } from '$lib/site-config';
+
+export const prerender = true;
+
+export function GET() {
+	const body = generateLlmsFullTxt(
+		{ title: siteConfig.title, description: siteConfig.description, origin: siteConfig.url },
+		docs
+	);
+	return new Response(body, { headers: { 'content-type': 'text/plain; charset=utf-8' } });
+}

package/template/src/routes/llms.txt/+server.ts

@@ -0,0 +1,13 @@
+import { docs } from 'svelte-docsmith/llms';
+import { generateLlmsTxt } from 'svelte-docsmith';
+import { siteConfig } from '$lib/site-config';
+
+export const prerender = true;
+
+export function GET() {
+	const body = generateLlmsTxt(
+		{ title: siteConfig.title, description: siteConfig.description, origin: siteConfig.url },
+		docs
+	);
+	return new Response(body, { headers: { 'content-type': 'text/plain; charset=utf-8' } });
+}

package/template/src/routes/sitemap.xml/+server.ts

@@ -0,0 +1,13 @@
+import { docs } from 'svelte-docsmith/content';
+import { generateSitemap } from 'svelte-docsmith';
+import { siteConfig } from '$lib/site-config';
+
+export const prerender = true;
+
+export function GET() {
+	const body = generateSitemap(siteConfig.url ?? '', [
+		{ path: '/' },
+		...docs.map((d) => ({ path: d.path, lastmod: d.lastUpdated }))
+	]);
+	return new Response(body, { headers: { 'content-type': 'application/xml' } });
+}

package/template/static/robots.txt

@@ -0,0 +1,5 @@
+User-agent: *
+Allow: /
+
+# Update this to your deployed origin.
+Sitemap: https://your-docs.dev/sitemap.xml