@lupinum/ginko-content 0.1.2 → 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
 
@@ -74,7 +75,9 @@ Render the current route through the collection:
 ```vue
 <!-- pages/[...slug].vue -->
 <script setup lang="ts">
-const { page } = await useContentPage('pages')
+import { pages } from '~/content.config'
+
+const { page } = await useContentPage(pages)
 </script>
 
 <template>
@@ -89,8 +92,8 @@ const { page } = await useContentPage('pages')
   files
 - Markdown, Comark component tags, YAML, JSON, and CSV ingestion
 - locale-aware content routing
-- route-aware page loading with `useContentPage('pages')`
-- semantic previous/next route-page data through `useContentPage('pages', { surround })`
+- 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
@@ -115,6 +118,17 @@ 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.2",
+    "@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"