v2.9.0

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: '16'
       - uses: pnpm/action-setup@v2.4.0

CHANGELOG.md

@@ -1,6 +1,76 @@
 # Changelog
 
 
+## v2.9.0
+
+[compare changes](https://github.com/nuxt/content/compare/v2.8.5...v2.9.0)
+
+### 🚀 Enhancements
+
+- Add type to layout ([#2389](https://github.com/nuxt/content/pull/2389))
+- Add search ([#2146](https://github.com/nuxt/content/pull/2146))
+
+### 🩹 Fixes
+
+- **path-meta:** Prevent `undefined` error ([1257cb5c](https://github.com/nuxt/content/commit/1257cb5c))
+- Types import ([ee4ea3ad](https://github.com/nuxt/content/commit/ee4ea3ad))
+- Ignore regexes in fetchDirConfig ([#2362](https://github.com/nuxt/content/pull/2362))
+- Optional experimental options ([#2391](https://github.com/nuxt/content/pull/2391))
+- Update types and imports ([061192c5](https://github.com/nuxt/content/commit/061192c5))
+- Prevent duplicate parses ([a208567e](https://github.com/nuxt/content/commit/a208567e))
+- Prevent duplicate parses ([dae92681](https://github.com/nuxt/content/commit/dae92681))
+
+### 📖 Documentation
+
+- Update to latest ui-pro ([a08dc1b8](https://github.com/nuxt/content/commit/a08dc1b8))
+- Remove global style ([e58855fb](https://github.com/nuxt/content/commit/e58855fb))
+- Add terms ([798a0a8c](https://github.com/nuxt/content/commit/798a0a8c))
+- Add data pops in ContentRendererMarkdown and varaibles binding ([#2360](https://github.com/nuxt/content/pull/2360))
+- Update examples for content helpers composable ([b6ff9ba2](https://github.com/nuxt/content/commit/b6ff9ba2))
+- Upgrade deps ([feca11b6](https://github.com/nuxt/content/commit/feca11b6))
+- Improve home ([fe357920](https://github.com/nuxt/content/commit/fe357920))
+- Add links for shiki on home ([#2386](https://github.com/nuxt/content/pull/2386))
+- Update highlight.preload config ([#2395](https://github.com/nuxt/content/pull/2395))
+- Grammatical tweaks on markdown page ([#2394](https://github.com/nuxt/content/pull/2394))
+- Update bindings with default value ([#2397](https://github.com/nuxt/content/pull/2397))
+- Update 3.search.md ([40a2e5de](https://github.com/nuxt/content/commit/40a2e5de))
+
+### ❤️ Contributors
+
+- Farnabaz ([@farnabaz](http://github.com/farnabaz))
+- Sébastien Chopin ([@Atinux](http://github.com/Atinux))
+- Estéban <e.soubiran25@gmail.com>
+- Maxime Pauvert ([@maximepvrt](http://github.com/maximepvrt))
+- AaronBeaudoin <aaronjbeaudoin@gmail.com>
+- Ashour <ashour.mohammad@gmail.com>
+- Mathieu NICOLAS 
+- Benjamin Canac ([@benjamincanac](http://github.com/benjamincanac))
+- Vincent Giersch <vincent@giersch.fr>
+
+## v2.8.5
+
+[compare changes](https://github.com/nuxt/content/compare/v2.8.4...v2.8.5)
+
+### 🩹 Fixes
+
+- **prose-pre:** `style` prop type ([1edb3501](https://github.com/nuxt/content/commit/1edb3501))
+
+### ❤️ Contributors
+
+- Farnabaz <farnabaz@gmail.com>
+
+## v2.8.4
+
+[compare changes](https://github.com/nuxt/content/compare/v2.8.3...v2.8.4)
+
+### 🩹 Fixes
+
+- **prose-pre:** Only wrap `slot` in `pre` ([#2348](https://github.com/nuxt/content/pull/2348))
+
+### ❤️ Contributors
+
+- Farnabaz <farnabaz@gmail.com>
+
 ## v2.8.3
 
 [compare changes](https://github.com/nuxt/content/compare/v2.8.2...v2.8.3)

docs/.env.example

@@ -1,5 +1,5 @@
 # To use Nuxt UI Pro in production
-NUXT_UI_PRO_TOKEN=
+NUXT_UI_PRO_LICENSE=
 
 # Used when pre-rendering the docs for dynamic OG images
 NUXT_PUBLIC_SITE_URL=

docs/app.config.ts

@@ -11,6 +11,15 @@ export default defineAppConfig({
           outline: 'ring-1 ring-inset ring-gray-700 text-white dark:text-white hover:bg-gray-900 disabled:bg-gray-300 dark:hover:bg-gray-900 dark:disabled:bg-gray-300 focus-visible:ring-2 focus-visible:ring-gray-400 dark:focus-visible:ring-gray-400'
         }
       }
+    },
+    content: {
+      prose: {
+        code: {
+          icon: {
+            // terminal: 'i-ph-terminal'
+          }
+        }
+      }
     }
   },
   elements: {

docs/app.vue

@@ -35,8 +35,8 @@ const { data: files } = useLazyFetch('/api/search.json', {
 const { data: nav } = await useAsyncData('navigation', () => fetchContentNavigation())
 
 const navigation = computed(() => {
-  const main = nav.value.filter(item => item._path !== '/v1')
-  const v1 = nav.value.find(item => item._path === '/v1')?.children
+  const main = nav.value?.filter(item => item._path !== '/v1')
+  const v1 = nav.value?.find(item => item._path === '/v1')?.children
 
   return route.path.startsWith('/v1/') ? v1 : main
 })
@@ -48,7 +48,7 @@ provide('navigation', navigation)
 <template>
   <UHeader :links="links">
     <template #logo>
-      <Logo class="h-5 w-auto" />
+      <Logo class="h-6 w-auto" />
     </template>
 
     <template #right>
@@ -81,7 +81,7 @@ provide('navigation', navigation)
     <!-- Mobile panel -->
     <template v-if="$route.path !== '/'" #panel>
       <LazyUDocsSearchButton size="md" class="mb-4 w-full" />
-      <LazyUNavigationTree :links="mapContentNavigation(navigation)" default-open :multiple="false" />
+      <LazyUNavigationTree :links="mapContentNavigation(navigation!)" default-open :multiple="false" />
     </template>
   </UHeader>
 
@@ -129,11 +129,3 @@ provide('navigation', navigation)
     <LazyUDocsSearch :files="files" :navigation="navigation" :links="links" />
   </ClientOnly>
 </template>
-
-<style>
-html.dark .shiki,
-html.dark .shiki span {
-  color: var(--s-dark) !important;
-  background-color: var(--s-dark-bg) !important;
-}
-</style>

docs/content/1.get-started/1.installation.md

@@ -22,7 +22,7 @@ Before getting started, please **make sure to have installed the recommended set
 
 1. You can start a fresh Nuxt Content project with:
 
-```bash [npx]
+```bash [Terminal]
 npx nuxi@latest init content-app -t content
 ```
 

docs/content/1.get-started/2.configuration.md

@@ -238,17 +238,10 @@ export default defineNuxtConfig({
   content: {
     highlight: {
       preload: [
-        {
-          id: 'gdscript',
-          scopeName: 'source.gdscript',
-          aliases: ['gdscript', 'gd'], // Use to mark code blocks in Markdown
-          grammar: JSON.parse(
-            readFileSync(
-              // Place the language grammar file somewhere in your project
-              './shiki/languages/gdscript.tmLanguage.json'
-            ).toString()
-          ),
-        },
+        // Read more about shikiji languages: https://github.com/antfu/shikiji#fine-grained-bundle
+        JSON.parse(
+          readFileSync('./shiki/languages/gdscript.tmLanguage.json', 'utf-8'),
+        ),
       ],
     },
   },
@@ -408,3 +401,56 @@ export default defineNuxtConfig({
 - Default: `{}`
 
 Options for yaml parser.
+
+## `experimental`
+
+### `search`
+
+- Type: `boolean | undefined`{lang=ts}
+- Default: `undefined`{lang=ts}
+
+Enable search feature.
+
+#### `indexed`
+
+- Type: `boolean`{lang=ts}
+- Default: `true`{lang=ts}
+
+Enable indexed search. This will generate a search index file that allow faster and more performant search.
+
+#### `ignoredTags`
+
+- Type: `string[]`{lang=ts}
+- Default: `['style', 'code']`{lang=ts}
+
+List of tags to ignore when parsing content for the search API response. This is useful to avoid including code snippets in the search results or style that does not provide any useful information.
+
+#### `filterQuery`
+
+- Type: `QueryBuilderWhere`{lang=ts}
+- Default: `{}`{lang=ts}
+
+Query to ignore when parsing content for the search API response. This is useful to avoid including content that is not meant to be searchable like drafts or private content.
+
+#### `options`
+
+- Type: `object`{lang=ts}
+- Default:
+
+```ts
+{
+  fields: ['title', 'content', 'titles'],
+  storeFields: ['title', 'content', 'titles'],
+  searchOptions: {
+    prefix: true,
+    fuzzy: 0.2,
+    boost: {
+      title: 4,
+      content: 2,
+      titles: 1
+    }
+  }
+}
+```
+
+When the indexed search is enabled, this option will automatically configure both the API endpoint and the `searchContent` composable. For simple search, you will need to pass the options to the `searchContent` composable.

docs/content/2.usage/2.markdown.md

@@ -5,7 +5,7 @@ description: "Nuxt Content uses the Markdown syntax and conventions to provide a
 
 ## Introduction
 
-We create the MDC syntax to superchage the Markdown syntax to give the ability to leverage the power of Vue components with slots and props.
+We created the MDC syntax to supercharge Markdown and give you the ability to leverage the power of Vue components with slots and props.
 
 ::callout
 Install the [MDC VS Code extension](https://marketplace.visualstudio.com/items?itemName=Nuxt.mdc) to get proper syntax highlighting for your MDC components.
@@ -458,6 +458,45 @@ In addition to mdc components and `span`, attribute syntax will work on images,
   ::
 ::
 
+## Binding Data in Markdown
+
+You can bind data within your Markdown document using the `{{ $doc.variable || 'defaultValue' }}` syntax. These values can be defined in the YAML front matter at the top of the document, within each MDC component, or injected using the `data` prop of the `<ContentRendererMarkdown>` component.
+
+### Example 1: Define in YAML
+
+```md
+---
+title: 'Title of the page'
+description: 'meta description of the page'
+customVariable: 'Custom Value'
+---
+
+# The Title is {{ $doc.title }} and customVariable is {{ $doc.customVariable || 'defaultValue' }}
+
+```
+
+### Example 2: Define in external with `<ContentRendererMarkdown>` 
+
+```html
+<template>
+  <div>
+    <ContentRendererMarkdown :value="data" :data="mdcVars"/>
+    <button type="button" v-on:click="mdcVars.name = 'Hugo'">Change name</button>
+  </div>
+</template>
+
+<script setup lang="ts">
+const { data } = await useAsyncData(() => queryContent('test').findOne());
+const mdcVars = ref({ name: 'Maxime'});
+</script>
+```
+
+```md
+
+# Hello {{ $doc.name || 'World' }}
+
+```
+
 ## Prose Components
 
 In Nuxt Content, the prose represents HTML tags generated by the Markdown syntax, such as title levels and links.

docs/content/2.usage/3.files.md

@@ -17,7 +17,7 @@ Nuxt Content can query JSON formatted content.
 ```
 
 ```ts [Query]
-await queryContent('/hello').fetchOne()
+await queryContent('/hello').findOne()
 ```
 
 ```js [Output]
@@ -53,7 +53,7 @@ category: announcement
 ```
 
 ```ts [Query]
-await queryContent('/hello').fetchOne()
+await queryContent('/hello').findOne()
 ```
 
 ```js [Output]
@@ -89,7 +89,7 @@ Hello Content v2!,The writing experience for Nuxt 3,announcement
 ```
 
 ```ts [Query]
-await queryContent('/hello').fetchOne()
+await queryContent('/hello').findOne()
 ```
 
 ```js [Output]