@kamod-ch/preactpress 1.0.2 → 2.0.0

package/templates/docs/examples/rss.md

@@ -0,0 +1,104 @@
+---
+title: RSS / Atom feed
+description: Generate a static feed.xml for blogs, changelogs, and magazine-style sites.
+tags:
+  - examples
+  - deploy
+---
+
+PreactPress can generate a static `feed.xml` during production builds. The feed uses the Atom XML format and is suitable for RSS readers.
+
+## Enable the feed
+
+Set `site.url` and enable `build.feed` in `.preactpress/config.ts`:
+
+```ts [.preactpress/config.ts]
+import { defineConfig } from "@kamod-ch/preactpress/config";
+
+export default defineConfig({
+  site: {
+    title: "Acme Blog",
+    description: "Product updates and engineering notes",
+    url: "https://example.com",
+  },
+
+  build: {
+    feed: { limit: 20 },
+  },
+});
+```
+
+After running a production build, PreactPress writes:
+
+```txt
+dist/feed.xml
+```
+
+## Add page metadata
+
+Feed entries use each page's title, description, route, and `lastUpdated` value.
+
+```md [posts/launch.md]
+---
+title: Launch notes
+description: What shipped in our first public release.
+lastUpdated: 2026-07-01T10:00:00.000Z
+tags:
+  - changelog
+---
+
+We shipped the first public version today.
+```
+
+## Build and inspect
+
+```sh
+pnpm run build
+```
+
+Then open or publish:
+
+```txt
+https://example.com/feed.xml
+```
+
+## Link the feed from your HTML head
+
+You can expose the feed to browsers and feed readers with `transformHead`:
+
+```ts [.preactpress/config.ts]
+import { defineConfig } from "@kamod-ch/preactpress/config";
+
+export default defineConfig({
+  site: {
+    title: "Acme Blog",
+    description: "Product updates and engineering notes",
+    url: "https://example.com",
+  },
+
+  build: {
+    feed: { limit: 20 },
+  },
+
+  transformHead() {
+    return [
+      [
+        "link",
+        {
+          rel: "alternate",
+          type: "application/atom+xml",
+          title: "Acme Blog feed",
+          href: "/feed.xml",
+        },
+      ],
+    ];
+  },
+});
+```
+
+## Notes
+
+- Feed generation requires `site.url`.
+- Draft pages are excluded from production output and therefore from the feed.
+- `build.feed: true` includes all pages.
+- `build.feed: { limit: 20 }` keeps only the newest entries.

package/templates/docs/guide/custom-themes.md

@@ -36,4 +36,4 @@ export default Layout;
 
 Theme authors are responsible for navigation, responsive behavior, focus management, search UI, and rendering Markdown versus MDX pages. Helpers for routes, page head data, tags, slugs, and theme state are exported from `@kamod-ch/preactpress/client` and `@kamod-ch/preactpress/shared`.
 
-The `magazine` and `hono` init templates are complete custom-theme examples.
+See the [custom theme example](/examples/custom-theme) for a copy-pasteable minimal theme. The `magazine` and `hono` init templates are complete custom-theme examples.

package/templates/docs/guide/deploy.md

@@ -97,6 +97,8 @@ For most static hosts, use these settings:
 | Cloudflare Pages   | `pnpm run build` | `dist`           |
 | Render Static Site | `pnpm run build` | `dist`           |
 
+See the [Cloudflare Pages deployment guide](/examples/cloudflare-pages) for dashboard settings, environment variables, Wrangler deployment, and custom domain notes.
+
 Install command:
 
 ```bash

package/templates/docs/guide/markdown-and-mdx.md

@@ -7,7 +7,7 @@ Use `.md` for content that does not need browser-side components. Use `.mdx` whe
 
 ## Markdown
 
-Markdown pages support frontmatter, heading anchors, syntax highlighting, tables, containers, GFM alerts, code groups, file includes, snippet imports, emoji, optional MathJax, and `[[toc]]`.
+Markdown pages support frontmatter, heading anchors, syntax highlighting, Mermaid diagrams, tables, containers, GFM alerts, code groups, file includes, snippet imports, emoji, optional MathJax, and `[[toc]]`.
 
 ```md
 ---

package/templates/docs/markdown-examples.md

@@ -23,6 +23,16 @@ export function greet(name: string) {
 
 Inline code like `themeConfig.outline` uses the same theme tokens as code blocks.
 
+## Mermaid diagrams
+
+Use a `mermaid` fenced code block to render diagrams in Markdown and MDX pages:
+
+```mermaid
+graph TD
+  A[Markdown] --> B[PreactPress]
+  B --> C[Static HTML]
+```
+
 ## Snippet import
 
 Reuse source files instead of duplicating code: