Merge pull request #2264 from nuxt/main

v2.8

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: '16'
-      - uses: pnpm/action-setup@v2.2.4
+      - uses: pnpm/action-setup@v2.4.0
         name: Install pnpm
         id: pnpm-install
         with:

CHANGELOG.md

@@ -1,6 +1,60 @@
 # Changelog
 
 
+## v2.8.0
+
+[compare changes](https://github.com/nuxt/content/compare/v2.7.2...v2.8.0)
+
+### 🚀 Enhancements
+
+- Add count method ([#1924](https://github.com/nuxt/content/pull/1924))
+- **nuxt-mdc:** Extract markdown parser ([#2187](https://github.com/nuxt/content/pull/2187))
+- Advanced query schema ([#2213](https://github.com/nuxt/content/pull/2213))
+- Allow to disable content head ([#2142](https://github.com/nuxt/content/pull/2142))
+
+### 🩹 Fixes
+
+- Markdown render compatiblity ([d81a08a2](https://github.com/nuxt/content/commit/d81a08a2))
+- **slot:** Rename ContentSlot to MDCSlot in render function ([efc60481](https://github.com/nuxt/content/commit/efc60481))
+- **module:** Slot transform sourcemap ([7558cf0d](https://github.com/nuxt/content/commit/7558cf0d))
+- **ProseImg:** Prevent conflict between `src` and baseURL ([#2242](https://github.com/nuxt/content/pull/2242))
+- Custom drivers failed on build ([#2193](https://github.com/nuxt/content/pull/2193))
+- **ContentRenderer:** Render contents only with excerpt ([#2246](https://github.com/nuxt/content/pull/2246))
+- **content-slot:** Better slot name regex ([329cf3bc](https://github.com/nuxt/content/commit/329cf3bc))
+
+### 📖 Documentation
+
+- Pre-render pages ([#2196](https://github.com/nuxt/content/pull/2196))
+- **v1:** Link button wrapping for small screens ([#2199](https://github.com/nuxt/content/pull/2199))
+- Add count method ([#2200](https://github.com/nuxt/content/pull/2200))
+- Add edge alert ([c582469c](https://github.com/nuxt/content/commit/c582469c))
+- Update README.md ([#2226](https://github.com/nuxt/content/pull/2226))
+- **mdc:** Fix `{attribute}` examples ([#2228](https://github.com/nuxt/content/pull/2228))
+- Add warning for `<NuxtPage/>` existence in `app.vue` ([#2244](https://github.com/nuxt/content/pull/2244))
+- `<ContentDoc>` slot example ([0bfc275d](https://github.com/nuxt/content/commit/0bfc275d))
+- Fix prose links ([aa61d9fd](https://github.com/nuxt/content/commit/aa61d9fd))
+- Update prose source links ([9720a333](https://github.com/nuxt/content/commit/9720a333))
+
+### 🏡 Chore
+
+- Upgrade `nuxt-mdc` ([1fef2137](https://github.com/nuxt/content/commit/1fef2137))
+- Update social card ([a7e308ae](https://github.com/nuxt/content/commit/a7e308ae))
+- Upgrade deps ([cf3e927c](https://github.com/nuxt/content/commit/cf3e927c))
+- Upgrade `nuxt-mdc` ([3db06b23](https://github.com/nuxt/content/commit/3db06b23))
+- Update to micromark v4 ([#2253](https://github.com/nuxt/content/pull/2253))
+- Use `@nuxtjs/mdc` ([ba4d0118](https://github.com/nuxt/content/commit/ba4d0118))
+
+### ❤️ Contributors
+
+- Farnabaz <farnabaz@gmail.com>
+- Cédric Exbrayat 
+- Yarrow 
+- Mathieu DARTIGUES ([@mdartic](http://github.com/mdartic))
+- Estéban <e.soubiran25@gmail.com>
+- Nobkd 
+- Maxime Pauvert ([@maximepvrt](http://github.com/maximepvrt))
+- Sébastien Chopin ([@Atinux](http://github.com/Atinux))
+
 ## v2.7.2
 
 [compare changes](https://github.com/nuxt/content/compare/v2.7.1...v2.7.2)

README.md

@@ -1,4 +1,4 @@
-[![nuxt-content](https://user-images.githubusercontent.com/904724/221176888-d9efefbe-0a8a-4d6b-beb2-5cc7d7dcad05.png)](https://content.nuxtjs.org)
+[![nuxt-content-social-card](https://github.com/nuxt/content/assets/904724/1cedd2ef-94fc-4210-aa84-5ab0dc449228)](https://content.nuxtjs.org)
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
@@ -37,7 +37,7 @@ Nuxt 2 is supported with Content v1, documentation is on <https://content.nuxtjs
 - Clone repository
 - Install dependencies using `pnpm install`
 - Prepare using `pnpm prepare`
-- Prepare using `pnpm build`
+- Build using `pnpm build`
 - Try playground using `pnpm dev`
 - Test using `pnpm test`
 

docs/components/content/ChangeLog.vue

@@ -1,6 +1,6 @@
 <template>
   <div>
-    <GithubReleases v-slot="{releases}">
+    <GithubReleases v-slot="{ releases }">
       <div v-for="release in releases" :key="release.name" class="release">
         <div class="release-name">
           <h2 class="">

docs/components/content/V1DocsLinks.vue

@@ -5,12 +5,15 @@
       <button-link href="/v1/getting-started/introduction" :transparent="true" color="false" size="large">
         English
       </button-link>
-      <button-link href="/fr/v1/getting-started/introduction" :transparent="true" color="false" class="ml-2" size="large">
+      <button-link href="/fr/v1/getting-started/introduction" :transparent="true" color="false" size="large">
         French
       </button-link>
-      <button-link href="/ja/v1/getting-started/introduction" :transparent="true" color="false" class="ml-2" size="large">
+      <button-link href="/ja/v1/getting-started/introduction" :transparent="true" color="false" size="large">
         Japanese
       </button-link>
+      <button-link href="/ru/v1/getting-started/introduction" :transparent="true" color="false" size="large">
+        Russian
+      </button-link>
     </div>
     <ellipsis />
   </div>
@@ -34,6 +37,7 @@ css({
   },
   '.links-wrapper': {
     display: 'flex',
+    flexWrap: 'wrap',
     gap: '2rem',
     justifyContent: 'center'
   },

docs/content-v1/en/1.getting-started/3.writing.md

@@ -32,7 +32,7 @@ The `createdAt` and `updatedAt` properties are based on the file's actual create
 
 This module converts your `.md` files into a JSON AST tree structure, stored in a `body` variable.
 
-Make sure to use the `<nuxt-content>` component to display the `body` of your markdown content, see [displaying content](/displaying).
+Make sure to use the `<nuxt-content>` component to display the `body` of your markdown content, see [displaying content](/v1/getting-started/displaying).
 
 > You can check the [basic syntax guide](https://www.markdownguide.org/basic-syntax) to help you master Markdown
 
@@ -133,7 +133,7 @@ It will be transformed to its JSON AST structure, and by using the `nuxt-content
 
 ### Links
 
-Links are transformed to add valid `target` and `rel` attributes using [remark-external-links](https://github.com/remarkjs/remark-external-links). You can check [here](/configuration#markdown) to learn how to configure this plugin.
+Links are transformed to add valid `target` and `rel` attributes using [remark-external-links](https://github.com/remarkjs/remark-external-links). You can check [here](/v1/getting-started/configuration#markdown) to learn how to configure this plugin.
 
 Relative links are also automatically transformed to [nuxt-link](https://nuxtjs.org/api/components-nuxt-link/) to provide navigation between page components with enhanced performance through smart prefetching.
 
@@ -159,7 +159,7 @@ title: Home
 
 ### Footnotes
 
-This module supports extended markdown syntax for footnotes using [remark-footnotes](https://github.com/remarkjs/remark-footnotes). You can check [here](/configuration#markdown) to learn how to configure this plugin.
+This module supports extended markdown syntax for footnotes using [remark-footnotes](https://github.com/remarkjs/remark-footnotes). You can check [here](/v1/getting-started/configuration#markdown) to learn how to configure this plugin.
 
 Here is an example using footnotes:
 
@@ -181,7 +181,7 @@ Here's a simple footnote,[^1] and here's a longer one.[^bignote]
 
 ### Codeblocks
 
-This module automatically wraps codeblocks and applies [PrismJS](https://prismjs.com) classes (see [syntax highlighting](/writing#syntax-highlighting)).
+This module automatically wraps codeblocks and applies [PrismJS](https://prismjs.com) classes (see [syntax highlighting](/v1/getting-started/writing#syntax-highlighting)).
 
 Codeblocks in Markdown are wrapped inside 3 backticks. Optionally, you can define the language of the codeblock to enable specific syntax highlighting.
 
@@ -226,7 +226,7 @@ Filename will be converted to a span with a `filename` class. It's up to you to
 
 ### Syntax highlighting
 
-It supports by default code highlighting using [PrismJS](https://prismjs.com) and injects the theme defined in options into your Nuxt.js app, see [configuration](/configuration#markdownprismtheme).
+It supports by default code highlighting using [PrismJS](https://prismjs.com) and injects the theme defined in options into your Nuxt.js app, see [configuration](/v1/getting-started/configuration#markdownprismtheme).
 
 ### HTML
 
@@ -274,7 +274,7 @@ You can use global Vue components or locally registered in the page you're displ
 
 <alert type="warning">
 
-An issue exists with locally registered components and live edit in development, since **v1.5.0** you can disable it by setting `liveEdit: false` (see [configuration](/configuration#liveedit)).
+An issue exists with locally registered components and live edit in development, since **v1.5.0** you can disable it by setting `liveEdit: false` (see [configuration](/v1/getting-started/configuration#liveedit)).
 
 </alert>
 
@@ -338,7 +338,7 @@ multiselectOptions:
 
 <alert type="info">
 
-These components will be rendered using the `<nuxt-content>` component, see [displaying content](/displaying#component).
+These components will be rendered using the `<nuxt-content>` component, see [displaying content](/v1/getting-started/displaying#component).
 
 </alert>
 
@@ -399,7 +399,7 @@ When fetching a document, we have access to a toc property which is an array of
 
 <alert type="info">
 
-Check out [this snippet](/snippets#table-of-contents) on how to implement a table of contents into your app
+Check out [this snippet](/v1/community/snippets#table-of-contents) on how to implement a table of contents into your app
 
 </alert>
 
@@ -474,7 +474,7 @@ Will be transformed into:
 }
 ```
 
-We internally add a `text` key with the markdown body that will be used for [searching](/fetching#searchfield-value) or [extending](/advanced#contentfilebeforeinsert) it.
+We internally add a `text` key with the markdown body that will be used for [searching](/v1/getting-started/fetching#searchfield-value) or [extending](/v1/getting-started/advanced#contentfilebeforeinsert) it.
 
 ## JSON / JSON5
 
@@ -486,7 +486,7 @@ Data defined will be injected into the document.
 
 <badge>v0.10.0+</badge>
 
-You can now use arrays inside your `.json` files. Objects will be flattened and inserted into the collection. You can [fetch](/fetching) your content in the same way as your used to.
+You can now use arrays inside your `.json` files. Objects will be flattened and inserted into the collection. You can [fetch](/v1/getting-started/fetching) your content in the same way as your used to.
 
 <alert type="warning">
 

docs/content-v1/en/1.getting-started/4.fetching.md

@@ -80,7 +80,7 @@ const articles = await this.$content('articles').where({ age: { $gt: 18 } }).fet
 const articles = await this.$content('articles').where({ name: { $in: ['odin', 'thor'] } }).fetch()
 ```
 
-In order to filter in objects and array you need to enable nestedProperties, see [configuration](/configuration#nestedproperties).
+In order to filter in objects and array you need to enable nestedProperties, see [configuration](/v1/getting-started/configuration#nestedproperties).
 
 ```js
 const products = await this.$content('products').where({ 'categories.slug': { $contains: 'top' } }).fetch()
@@ -112,7 +112,7 @@ const articles = await this.$content('articles').sortBy('title').fetch()
 
 `sortBy` method does **case-sensitive** sort, which is currently not configurable.
 
-If you need case-insensitive sorting, check out [this snippet](/snippets#case-insensitive-sorting) on how to work around it.
+If you need case-insensitive sorting, check out [this snippet](/v1/community/snippets#case-insensitive-sorting) on how to work around it.
 
 </alert>
 
@@ -152,7 +152,7 @@ const articles = await this.$content('articles').skip(5).limit(5).fetch()
 
 Performs a full-text search on a field. `value` is optional, in this case `field` is the `value` and search will be performed on all defined full-text search fields.
 
-The fields you want to search on must be defined in options in order to be indexed, see [configuration](/configuration#fulltextsearchfields).
+The fields you want to search on must be defined in options in order to be indexed, see [configuration](/v1/getting-started/configuration#fulltextsearchfields).
 
 Using an empty string as parameter will skip the search.
 
@@ -167,7 +167,7 @@ const articles = await this.$content('articles').search('').fetch()
 
 <alert type="info">
 
-Check out [this snippet](/snippets#search) on how to implement search into your app
+Check out [this snippet](/v1/community/snippets#search) on how to implement search into your app
 
 </alert>
 
@@ -212,7 +212,7 @@ Getting results based on `path` is only supported since v1.12.0
 
 <alert type="info">
 
-Check out [this snippet](/snippets#prev-and-next) on how to implement prev and next links into your app
+Check out [this snippet](/v1/community/snippets#prev-and-next) on how to implement prev and next links into your app
 
 </alert>
 
@@ -249,4 +249,4 @@ const articles = await this.$content('articles')
   })
 ```
 
-> You can check how to use the [Content API](/advanced#api-endpoint) in development.
+> You can check how to use the [Content API](/v1/getting-started/advanced#api-endpoint) in development.

docs/content-v1/en/1.getting-started/5.displaying.md

@@ -40,11 +40,11 @@ export default {
 - tag:
   - Type: `string`
 
-Learn more about what you can write in your markdown file in the [writing content](/writing#markdown) section.
+Learn more about what you can write in your markdown file in the [writing content](/v1/getting-started/writing#markdown) section.
 
 ### Excerpt
 
-If you are utilizing the [excerpt](/writing#excerpt) feature, you can display the content of your excerpt using the following model:
+If you are utilizing the [excerpt](/v1/getting-started/writing#excerpt) feature, you can display the content of your excerpt using the following model:
 
 ```vue
 <template>

docs/content-v1/en/1.getting-started/6.configuration.md

@@ -59,7 +59,7 @@ content: {
 - Type: `Array`
 - Default: `['title', 'description', 'slug', 'text']`
 
-Fields that needs to be indexed to be searchable, learn more about search [here](/fetching#searchfield-value).
+Fields that needs to be indexed to be searchable, learn more about search [here](/v1/getting-started/fetching#searchfield-value).
 
 `text` is a special key that contains your Markdown before being parsed to AST.
 
@@ -431,7 +431,7 @@ export default {
 }
 ```
 
-> You can head over to [Snippets - Custom Highlighter](/snippets#custom-highlighter) section to see more example.
+> You can head over to [Snippets - Custom Highlighter](/v1/community/snippets#custom-highlighter) section to see more example.
 
 ### `yaml`
 

docs/content-v1/en/1.getting-started/7.advanced.md

@@ -99,7 +99,7 @@ Arguments:
 - `document`
   - Type: `object`
   - Properties:
-    - See [writing content](/writing)
+    - See [writing content](/v1/getting-started/writing)
 - `database`
   - Type: `object`
   - Properties:
@@ -157,7 +157,7 @@ Arguments:
 - `options`
   - Type: `object`
   - Properties:
-    - See [configuration](/configuration#properties)
+    - See [configuration](/v1/getting-started/configuration#properties)
 
 **Example**
 
@@ -213,7 +213,7 @@ This documentation uses it actually. You can learn more by looking at [plugins/i
 
 ## API Endpoint
 
-This module exposes an API endpoint in development so you can easily see the JSON of each directory or file, it is available on [http://localhost:3000/_content/](http://localhost:3000/_content/). The prefix is `_content` by default and can be configured with the [apiPrefix](/configuration#apiprefix) property.
+This module exposes an API endpoint in development so you can easily see the JSON of each directory or file, it is available on [http://localhost:3000/_content/](http://localhost:3000/_content/). The prefix is `_content` by default and can be configured with the [apiPrefix](/v1/getting-started/configuration#apiprefix) property.
 
 **Example**
 
@@ -246,7 +246,7 @@ Since **v1.4.0**, this endpoint also supports `where` in query params:
 
 > This module uses LokiJS under the hood. You can check here for [query examples](https://github.com/techfort/LokiJS/wiki/Query-Examples#find-queries).
 
-- You can use [nested properties](/configuration#nestedproperties):
+- You can use [nested properties](/v1/getting-started/configuration#nestedproperties):
 
 `http://localhost:3000/_content/products?categories.slug_contains=top`
 

docs/content-v1/en/3.community/1.snippets.md

@@ -98,7 +98,7 @@ export default {
 </script>
 ```
 
-> Check out the [search documentation](/fetching#searchfield-value)
+> Check out the [search documentation](/v1/getting-started/fetching#searchfield-value)
 
 ### Prev and Next
 
@@ -145,7 +145,7 @@ even when the current page is showing the higer-positioned document.
 
 </alert>
 
-> Check out the [surround documentation](/fetching#surroundslugorpath-options)
+> Check out the [surround documentation](/v1/getting-started/fetching#surroundslugorpath-options)
 
 ### Case-Insensitive Sorting
 
@@ -185,7 +185,7 @@ export default {
 }
 ```
 
-> Check out the [`sortBy` documentation](/fetching#sortbykey-direction)
+> Check out the [`sortBy` documentation](/v1/getting-started/fetching#sortbykey-direction)
 
 ### Table of contents
 
@@ -218,7 +218,7 @@ export default {
 </script>
 ```
 
-> Check out the [Table of contents documentation](/writing#table-of-contents)
+> Check out the [Table of contents documentation](/v1/getting-started/writing#table-of-contents)
 
 ### Dynamic routing