@lupinum/ginko-content 0.1.1 → 0.1.3

package/README.md

@@ -13,7 +13,8 @@ and server-side reads.
 ## Requirements
 
 - Node.js 20 or later
-- Nuxt 4.0 or later
+- Nuxt 4.4.7 or later
+- Vue 3.5 or later
 
 ## Install
 
@@ -45,7 +46,7 @@ Define a collection:
 // content.config.ts
 import { defineCollection, defineContentConfig } from '@lupinum/ginko-content/config'
 
-export const pages = defineCollection('pages', {
+export const pages = defineCollection({
   type: 'page',
   source: '**/*.md'
 })
@@ -89,9 +90,10 @@ const { page } = await useContentPage(pages)
 - file-authored pages and navigation from `content/`
 - collection definitions as the source of truth for content shape and source
   files
-- Markdown, MDC, YAML, JSON, and CSV ingestion
+- Markdown, Comark component tags, YAML, JSON, and CSV ingestion
 - locale-aware content routing
-- route-aware page loading with `useContentPage(handle)`
+- route-aware page loading with `useContentPage(pages)`
+- semantic previous/next route-page data through `useContentPage(pages, { surround })`
 - server reads through `one`, `many`, `paginate`, `resolveOne`, `tree`, and
   `neighbors`
 - Vue composables for the same read model
@@ -99,6 +101,34 @@ const { page } = await useContentPage(pages)
 - sitemap integration for public content routes
 - a server-side provider contract for advanced custom sources
 
+## I18n, Sitemap, and Prerender Ownership
+
+For localized Nuxt apps, keep one source of truth per route type:
+
+- Static Nuxt page paths belong in Nuxt I18n `i18n.pages`.
+- Content page paths belong in Ginko collection routes and content files.
+- Sitemap XML is generated by `@nuxtjs/sitemap`.
+- Ginko registers the content sitemap source and contributes content prerender
+  routes.
+
+Do not duplicate docs, blog, pricing, privacy, or translated locale paths in
+`sitemap.urls` or app-owned `nitro.prerender.routes` arrays. Use
+`@nuxtjs/sitemap >= 8.0.15` when translated static app slugs such as `/preise`
+and `/en/pricing` need cross-locale sitemap alternates.
+
+See the public guide: [Sitemap and prerender](../../docs/content/docs/6.i18n/4.sitemap-prerender.md).
+
+## Integration Dependencies
+
+| Feature | Dependency model |
+| --- | --- |
+| Markdown highlighting and built-in Shiki transformers | Included as runtime dependencies of `@lupinum/ginko-content`. |
+| MiniSearch backend | Included as a runtime dependency and used by the default search backend. |
+| Pagefind backend | Included as a runtime dependency and used when `content.search.engine` is `'pagefind'`. |
+| Provider-owned search | No extra package. The active content provider must advertise and implement `search`. |
+| Content i18n | Install and configure `@nuxtjs/i18n` when the app uses Nuxt locale routes. |
+| Sitemap XML output | Install and configure `@nuxtjs/sitemap`; Ginko contributes the content sitemap source. |
+
 ## Scope
 
 The default provider reads files from your Nuxt project. The package does not

package/compatibility.json

@@ -1,7 +1,7 @@
 {
   "name": "Ginko Content release compatibility",
   "releaseStack": {
-    "@lupinum/ginko-content": "0.1.1",
+    "@lupinum/ginko-content": "0.1.3",
     "@lupinum/ginko-cms": "0.1.2",
     "@lupinum/ginko-cms-convex": "0.1.1",
     "@lupinum/ginko-cms-contract": "0.1.1"
@@ -13,7 +13,7 @@
     "convex": ["1.38.0", "^1.38.0"],
     "convex-helpers": ["^0.1.117", "0.1.117"],
     "h3": ["1.15.11"],
-    "nuxt": ["^4.4.6", "4.4.6", ">=4.0.0"],
+    "nuxt": ["^4.4.7", "4.4.7", ">=4.4.7"],
     "typescript": ["~6.0.3", "^6.0.3", "6.0.3"],
     "vite": ["^7.3.3", "7.3.3"],
     "vitest": ["^4.1.6", ">=4.1.6"],