@kamod-ch/preactpress 1.0.0 → 1.0.2

package/templates/docs/guide/getting-started.md

@@ -11,11 +11,11 @@ This guide shows how to create a PreactPress site, understand the generated file
 
 You need:
 
-| Requirement | Version |
-| --- | --- |
-| Node.js | 20 or higher |
-| Package manager | pnpm recommended; npm, yarn, and bun also work |
-| Editor | Any editor with Markdown and TypeScript support |
+| Requirement     | Version                                         |
+| --------------- | ----------------------------------------------- |
+| Node.js         | 20 or higher                                    |
+| Package manager | pnpm recommended; npm, yarn, and bun also work  |
+| Editor          | Any editor with Markdown and TypeScript support |
 
 ## Create a site
 
@@ -53,7 +53,6 @@ my-site/
 ├── README.md
 ├── index.html
 ├── index.md
-├── about.md
 ├── guide/
 │   └── first-five-minutes.md
 ├── markdown-examples.md
@@ -73,25 +72,25 @@ The starter config lives at `.preactpress/config.ts`:
 ```ts
 export default {
   site: {
-    title: 'My Docs',
-    description: 'Short summary for search and social previews'
+    title: "My Docs",
+    description: "Short summary for search and social previews",
   },
   themeConfig: {
     nav: [
-      { text: 'Home', link: '/' },
-      { text: 'Guide', link: '/guide/what-is-preactpress' }
+      { text: "Home", link: "/" },
+      { text: "Guide", link: "/guide/what-is-preactpress" },
     ],
     sidebar: [
       {
-        text: 'Introduction',
+        text: "Introduction",
         items: [
-          { text: 'What is PreactPress?', link: '/guide/what-is-preactpress' },
-          { text: 'Getting Started', link: '/guide/getting-started' }
-        ]
-      }
-    ]
-  }
-}
+          { text: "What is PreactPress?", link: "/guide/what-is-preactpress" },
+          { text: "Getting Started", link: "/guide/getting-started" },
+        ],
+      },
+    ],
+  },
+};
 ```
 
 Use `site` for site-wide metadata and `themeConfig` for default-theme options such as logo (`logo: '/logo.svg'`), nav, sidebar, search, outline, footer, and edit links.
@@ -102,7 +101,6 @@ PreactPress uses file-based routing. By default, the source directory is the pro
 
 ```text
 index.md                  -> /
-about.md                  -> /about
 guide/getting-started.md  -> /guide/getting-started
 interactive.mdx           -> /interactive
 ```
@@ -111,8 +109,8 @@ You can change the source directory with `srcDir`:
 
 ```ts
 export default {
-  srcDir: 'docs'
-}
+  srcDir: "docs",
+};
 ```
 
 With this config, PreactPress reads pages from `docs/` while `.preactpress/config.ts` still belongs to the project root.
@@ -121,12 +119,12 @@ With this config, PreactPress reads pages from `docs/` while `.preactpress/confi
 
 The starter includes npm scripts:
 
-| Command | Purpose |
-| --- | --- |
-| `pnpm run dev` | Start the dev server with SSR and hot reload |
-| `pnpm run check` | Validate config, routes, and links |
-| `pnpm run build` | Build the static production site into `dist/` |
-| `pnpm run preview` | Preview the production build locally |
+| Command            | Purpose                                       |
+| ------------------ | --------------------------------------------- |
+| `pnpm run dev`     | Start the dev server with SSR and hot reload  |
+| `pnpm run check`   | Validate config, routes, and links            |
+| `pnpm run build`   | Build the static production site into `dist/` |
+| `pnpm run preview` | Preview the production build locally          |
 
 You can also call the CLI directly:
 
@@ -139,8 +137,8 @@ pnpm exec preactpress preview
 
 ## What's next?
 
-| Page | Why |
-| --- | --- |
+| Page                                              | Why                                               |
+| ------------------------------------------------- | ------------------------------------------------- |
 | [Your first 5 minutes](/guide/first-five-minutes) | Change the title, add a page, and wire navigation |
-| [Routing](/guide/routing) | Learn how Markdown files map to URLs |
-| [Deploy](/guide/deploy) | Build and publish the generated `dist/` directory |
+| [Routing](/guide/routing)                         | Learn how Markdown files map to URLs              |
+| [Deploy](/guide/deploy)                           | Build and publish the generated `dist/` directory |

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

@@ -31,7 +31,7 @@ Raw HTML is disabled by default. Enable `markdown.html` only when every author i
 title: Counter demo
 ---
 
-import Counter from './components/Counter.tsx'
+import Counter from "./components/Counter.tsx";
 
 ## Demo
 

package/templates/docs/guide/routing.md

@@ -60,8 +60,8 @@ You can move content into a nested source directory with `srcDir`:
 
 ```ts
 export default {
-  srcDir: 'docs'
-}
+  srcDir: "docs",
+};
 ```
 
 That produces this shape:
@@ -97,6 +97,7 @@ Avoid linking directly to generated HTML or source Markdown:
 
 ```md
 <!-- Avoid -->
+
 [Getting Started](/guide/getting-started.md)
 [Getting Started](/guide/getting-started.html)
 ```
@@ -120,16 +121,16 @@ Configure locale labels, language codes, and locale-specific nav in `.preactpres
 export default {
   locales: {
     root: {
-      label: 'English',
-      lang: 'en'
+      label: "English",
+      lang: "en",
     },
     de: {
-      label: 'Deutsch',
-      lang: 'de',
-      link: '/de/'
-    }
-  }
-}
+      label: "Deutsch",
+      lang: "de",
+      link: "/de/",
+    },
+  },
+};
 ```
 
 The default theme shows a language switcher when multiple locales are configured.
@@ -167,9 +168,9 @@ Use `site.base` when the site is served from a subpath, for example GitHub Pages
 ```ts
 export default {
   site: {
-    base: '/my-repo/'
-  }
-}
+    base: "/my-repo/",
+  },
+};
 ```
 
 You can also override it for one build:
@@ -185,25 +186,25 @@ Map a public URL to existing content without duplicating files:
 ```ts
 export default {
   rewrites: {
-    '/docs': '/guide',
-    '/getting-started': '/guide/intro'
-  }
-}
+    "/docs": "/guide",
+    "/getting-started": "/guide/intro",
+  },
+};
 ```
 
 Keys are the routes visitors use; values must point at routes that already exist from your Markdown files. `preactpress check` validates rewrite sources and collisions.
 
 ## Clean URLs and hosting
 
-| `cleanUrls` | Output for `/about` | Typical host |
-| --- | --- | --- |
+| `cleanUrls`      | Output for `/about`     | Typical host                                    |
+| ---------------- | ----------------------- | ----------------------------------------------- |
 | `true` (default) | `dist/about/index.html` | Netlify, Vercel, Cloudflare Pages, GitHub Pages |
-| `false` | `dist/about.html` | Static buckets without directory index support |
+| `false`          | `dist/about.html`       | Static buckets without directory index support  |
 
 ```ts
 export default {
-  cleanUrls: false
-}
+  cleanUrls: false,
+};
 ```
 
 Most modern static hosts work with the default. Set `cleanUrls: false` only when your host cannot resolve `/about` to `about/index.html`.
@@ -213,10 +214,9 @@ Most modern static hosts work with the default. Set `cleanUrls: false` only when
 Generate routes at build time with a bracket template and a colocated `.paths.ts` file:
 
 ```md
-<!-- packages/[pkg].md -->
----
-title: "{{ params.pkg }}"
----
+## <!-- packages/[pkg].md -->
+
+## title: "{{ params.pkg }}"
 
 # {{ params.pkg }}
 ```
@@ -226,11 +226,11 @@ title: "{{ params.pkg }}"
 export default {
   paths() {
     return [
-      { params: { pkg: 'preact' } },
-      { params: { pkg: 'vite' }, props: { note: 'Build tool' } }
-    ]
-  }
-}
+      { params: { pkg: "preact" } },
+      { params: { pkg: "vite" }, props: { note: "Build tool" } },
+    ];
+  },
+};
 ```
 
 This emits `/packages/preact` and `/packages/vite`. Use `{{ params.key }}` and `{{ props.key }}` in frontmatter and body.
@@ -241,23 +241,23 @@ Colocate `*.data.ts` with a page to load build-time data via `createContentLoade
 
 ```ts
 // blog.data.ts
-import { createContentLoader } from '@kamod-ch/preactpress/config'
+import { createContentLoader } from "@kamod-ch/preactpress/config";
 
-export default createContentLoader('posts/*.md', {
+export default createContentLoader("posts/*.md", {
   transform(items) {
     return items.map((item) => ({
       title: item.title,
-      route: item.route
-    }))
-  }
-})
+      route: item.route,
+    }));
+  },
+});
 ```
 
 Pair with `blog.md` or `blog/index.md` for route `/blog`.
 
 ## Current limitations
 
-| Feature | Status |
-| --- | --- |
+| Feature                            | Status                              |
+| ---------------------------------- | ----------------------------------- |
 | Dynamic MDX templates (`[id].mdx`) | Not supported (use `.md` templates) |
-| Pattern-based rewrites with params | Not supported |
+| Pattern-based rewrites with params | Not supported                       |

package/templates/docs/guide/what-is-preactpress.md

@@ -36,18 +36,18 @@ The separate `preactpress-examples` project includes a custom-theme example that
 
 PreactPress focuses on keeping content work simple:
 
-| Feature | What it gives you |
-| --- | --- |
-| Vite dev server | Fast startup and hot updates while editing content |
+| Feature              | What it gives you                                                  |
+| -------------------- | ------------------------------------------------------------------ |
+| Vite dev server      | Fast startup and hot updates while editing content                 |
 | Markdown frontmatter | Page titles, descriptions, tags, draft status, and social metadata |
-| MDX | Preact components inside content pages |
-| Default theme | Nav, sidebar, outline, search, footer, locale switcher |
-| `preactpress check` | Config, route, and link validation before release |
+| MDX                  | Preact components inside content pages                             |
+| Default theme        | Nav, sidebar, outline, search, footer, locale switcher             |
+| `preactpress check`  | Config, route, and link validation before release                  |
 
 For regular content, use `.md`. When a page needs interactivity, use `.mdx` and import a Preact component:
 
 ```mdx
-import Counter from './components/Counter.tsx'
+import Counter from "./components/Counter.tsx";
 
 ## Demo
 
@@ -62,13 +62,13 @@ After hydration, client-side navigation takes over. Markdown pages are loaded as
 
 The production output is static files only:
 
-| Output | Purpose |
-| --- | --- |
-| `index.html`, `*/index.html` | One HTML file per route |
-| `assets/*` | Hashed JavaScript and CSS from Vite |
-| `preactpress-search.json` | Search data for the default theme |
-| `preactpress-content/*.json` | Lazy-loaded Markdown page payloads |
-| `404.html` | Not-found page |
+| Output                       | Purpose                             |
+| ---------------------------- | ----------------------------------- |
+| `index.html`, `*/index.html` | One HTML file per route             |
+| `assets/*`                   | Hashed JavaScript and CSS from Vite |
+| `preactpress-search.json`    | Search data for the default theme   |
+| `preactpress-content/*.json` | Lazy-loaded Markdown page payloads  |
+| `404.html`                   | Not-found page                      |
 
 ## What about VitePress?
 
@@ -80,8 +80,8 @@ PreactPress is also static-only in production. You build the site once, upload t
 
 ## Next steps
 
-| Page | Why |
-| --- | --- |
+| Page                                      | Why                                                      |
+| ----------------------------------------- | -------------------------------------------------------- |
 | [Getting Started](/guide/getting-started) | Install PreactPress and understand the starter structure |
-| [Routing](/guide/routing) | Learn how files become URLs |
-| [Deploy](/guide/deploy) | Build and publish a static site |
+| [Routing](/guide/routing)                 | Learn how files become URLs                              |
+| [Deploy](/guide/deploy)                   | Build and publish a static site                          |

package/templates/docs/index.html

@@ -12,7 +12,7 @@
   <body>
     <div id="app"></div>
     <script type="module">
-      import 'preactpress/app'
+      import "preactpress/app";
     </script>
   </body>
 </html>

package/templates/docs/index.mdx

@@ -0,0 +1,25 @@
+---
+layout: home
+title: PreactPress
+description: The documentation framework for Preact.
+sidebar: false
+pageClass: pp-mkt-page
+markdownStyles: false
+---
+
+import "./components/marketing.css";
+import BenefitsGrid from "./components/BenefitsGrid.tsx";
+import CliBlock from "./components/CliBlock.tsx";
+import ComparisonTable from "./components/ComparisonTable.tsx";
+import MarketingHero from "./components/MarketingHero.tsx";
+import MdxDemo from "./components/MdxDemo.tsx";
+import References from "./components/References.tsx";
+import TemplateGallery from "./components/TemplateGallery.tsx";
+
+<MarketingHero />
+<CliBlock />
+<MdxDemo />
+<BenefitsGrid />
+<TemplateGallery />
+<ComparisonTable />
+<References />

package/templates/docs/interactive.mdx

@@ -3,7 +3,7 @@ title: Interactive MDX
 description: Markdown with imported Preact components
 ---
 
-import Counter from './components/Counter.tsx'
+import Counter from "./components/Counter.tsx";
 
 ## Preact component
 

package/templates/docs/markdown-examples.md

@@ -1,11 +1,11 @@
 ---
 title: Markdown examples
-description: Rendered examples of PreactPress Markdown extensions.
+description: Common authoring snippets and rendered PreactPress Markdown extensions.
 tags:
   - markdown
 ---
 
-## Code highlighting
+## Code
 
 ```ts{2}
 export function greet(name: string) {
@@ -13,43 +13,87 @@ export function greet(name: string) {
 }
 ```
 
-Inline code such as `themeConfig.outline` uses the theme's code tokens.
+Highlight a single line with fence meta (`{2}`) or inline notation:
+
+```ts
+export function greet(name: string) {
+  return `Hello, ${name}!`; // [!code highlight]
+}
+```
+
+Inline code like `themeConfig.outline` uses the same theme tokens as code blocks.
 
 ## Snippet import
 
+Reuse source files instead of duplicating code:
+
 <<< @/snippets/greet.ts{2}
 
-## Containers and alerts
+The `@/` prefix resolves from the site content root (`srcDir`).
+
+## Links
+
+[Home](/) · [External link](https://preactjs.com)
+
+## Tables
+
+| Syntax            | Result        |
+| ----------------- | ------------- |
+| `# Title`         | Heading       |
+| `---` frontmatter | Page metadata |
+
+## Containers
+
+:::: tip
+`::: tip`, `::: warning`, `::: danger`, `::: info`, and `::: details` work like VitePress custom containers.
+::::
 
-::: tip
-Custom containers support `tip`, `warning`, `danger`, `info`, and `details`.
-:::
+:::: warning Optional title
+You can pass a custom title after the container type.
+::::
+
+:::: details Learn more
+Details blocks render as native `<details>` elements.
+::::
+
+## GFM alerts
+
+GitHub-flavored alert syntax renders with the same styling as custom containers:
 
 > [!NOTE]
-> GFM alert syntax is supported too.
+> Useful information that readers should know.
+
+> [!TIP]
+> Optional advice for doing things more easily.
+
+> [!WARNING]
+> Critical content that needs immediate attention.
+
+## Custom heading IDs
 
-## Table
+## Stable links {#stable-id}
 
-| Source | Result |
-| --- | --- |
-| `# Title` | Heading |
-| YAML frontmatter | Page metadata |
+Append `{#id}` to any heading to control its anchor.
 
-## Stable heading {#stable-heading}
+## Emoji
 
-Use `{#id}` to control a heading fragment.
+PreactPress supports `:tada:` and `:rocket:` shortcodes out of the box.
 
 ## Inline table of contents
 
 [[toc]]
 
-### Nested section
+### First section
 
-The generated table of contents includes level-three headings.
+Content below the inline TOC.
 
-## Code group
+### Second section
 
-::: code-group
+Nested heading for the outline.
+
+## Code groups
+
+:::: code-group
 
 ```bash [pnpm]
 pnpm add -D @kamod-ch/preactpress
@@ -59,9 +103,17 @@ pnpm add -D @kamod-ch/preactpress
 npm install --save-dev @kamod-ch/preactpress
 ```
 
-:::
+::::
+
+## Markdown inclusion
+
+Use includes for shared fragments or selected line ranges:
+
+<!--@include: @/parts/include-body.md{5,6}-->
+
+## Markdown includes
 
-## Included content
+Reuse shared fragments with HTML comments:
 
 <!--@include: @/partials/shared-note.md-->
 

package/templates/docs/package.json

@@ -10,6 +10,6 @@
   },
   "devDependencies": {
     "@kamod-ch/preactpress": "file:../..",
-    "typescript": "^5.8.3"
+    "typescript": "^6.0.3"
   }
 }

package/templates/docs/packages/[pkg].md

@@ -0,0 +1,15 @@
+---
+title: "{{ props.name }}"
+description: "Dynamic route example for {{ props.name }}."
+tags:
+  - examples
+  - dynamic-routes
+---
+
+# {{ props.name }}
+
+This page is generated from `packages/[pkg].md` and `packages/[pkg].paths.ts`.
+
+Package slug: `{{ params.pkg }}`
+
+{{ props.summary }}

package/templates/docs/packages/[pkg].paths.ts

@@ -0,0 +1,20 @@
+export default {
+  paths() {
+    return [
+      {
+        params: { pkg: "preactpress" },
+        props: {
+          name: "PreactPress",
+          summary: "The documentation framework package rendered as a static dynamic route.",
+        },
+      },
+      {
+        params: { pkg: "preact" },
+        props: {
+          name: "Preact",
+          summary: "A second route proves that one template can render multiple static pages.",
+        },
+      },
+    ];
+  },
+};

package/templates/docs/parts/include-body.md

@@ -2,6 +2,7 @@ Line one — skipped.
 Line two — skipped.
 Line three — skipped.
 Line four — skipped.
+
 ## Included body
 
 This paragraph is pulled in via `<!--@include: …{5,6}-->`.

package/templates/docs/pnpm-lock.yaml

@@ -12,8 +12,8 @@ importers:
         specifier: file:../..
         version: file:../..(@babel/core@7.29.7)(rollup@4.61.1)
       typescript:
-        specifier: ^5.8.3
-        version: 5.9.3
+        specifier: ^6.0.3
+        version: 6.0.3
 
 packages:
 
@@ -1234,8 +1234,8 @@ packages:
     resolution: {integrity: sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==}
     engines: {node: '>=16'}
 
-  typescript@5.9.3:
-    resolution: {integrity: sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==}
+  typescript@6.0.3:
+    resolution: {integrity: sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw==}
     engines: {node: '>=14.17'}
     hasBin: true
 
@@ -2833,7 +2833,7 @@ snapshots:
 
   type-fest@4.41.0: {}
 
-  typescript@5.9.3: {}
+  typescript@6.0.3: {}
 
   uc.micro@2.1.0: {}
 

package/templates/docs/public/preactpress-example.txt

@@ -0,0 +1 @@
+This file comes from templates/docs/public and is copied to dist/preactpress-example.txt.

package/templates/docs/snippets/greet.ts

@@ -1,3 +1,3 @@
 export function greet(name: string) {
-  return `Hello, ${name}!`
+  return `Hello, ${name}!`;
 }