Changelog

Publish your releases as a page and a feed, from the changelog you already have.

Every release you ship already produces release notes. DocSmith reads them and publishes them, so the changelog on your site can never fall behind what actually went out.

Where the entries come from

The docsmith() plugin parses a CHANGELOG.md into releases and serves them as the svelte-docsmith/changelog module. The format Changesets writes is what it expects: an ## <version> heading per release, ### Minor Changes style groups, and one bullet per entry. Commit hashes are stripped, multi-paragraph entries survive intact, and each entry’s markdown is rendered to HTML at build time so your site needs no runtime markdown renderer.

Release dates come from git: the commit that first introduced each version’s heading. No date is invented when the history is unavailable.

vite.config.ts

			// Defaults to CHANGELOG.md beside your app. In a monorepo, point it at the
// package you actually publish.
docsmith({ changelog: '../../packages/my-lib/CHANGELOG.md' });

Add the page

src/routes/changelog/+page.svelte

			<script>
	import { docs } from 'svelte-docsmith/content';
	import { releases } from 'svelte-docsmith/changelog';
	import { DocsShell, Changelog } from 'svelte-docsmith';
	import { siteConfig } from '$lib/site-config';
</script>

<DocsShell config={siteConfig} content={docs} layout="page">
	<Changelog {releases} description="What shipped in each release." />
</DocsShell>

Add the feed

An Atom feed makes each release something readers can subscribe to rather than something they have to check for.

src/routes/changelog.xml/+server.ts

			import { releases } from 'svelte-docsmith/changelog';
import { generateFeed } from 'svelte-docsmith';
import { siteConfig } from '$lib/site-config';

export const prerender = true;

export function GET() {
	const body = generateFeed(releases, {
		url: siteConfig.url,
		title: siteConfig.title
	});
	return new Response(body, {
		headers: { 'content-type': 'application/atom+xml; charset=utf-8' }
	});
}

Atom rather than RSS, because it requires an unambiguous id and timestamp per entry, which a version and its release date give exactly.

Write a proper post for a release

Generated entries are terse by design. When a release deserves more, add src/routes/changelog/<version>/ as a normal page and DocSmith links the release to it instead of to its anchor. Dots are awkward in directory names, so 0-9-0 works as well as 0.9.0. Every other release stays generated, so nothing goes undocumented while you write up the ones that matter.