nuxt / content

The file-based CMS for your Nuxt application, powered by Markdown and Vue components.
https://content.nuxt.com
MIT License
3.08k stars 624 forks source link

docs: mention that `searchContent` is an experimental feature #2505

Closed antfu closed 8 months ago

antfu commented 8 months ago

🔗 Linked issue

❓ Type of change

📚 Description

mention that searchContent is an experimental feature

📝 Checklist

nuxt-studio[bot] commented 8 months ago

Live Preview ready!

Name Edit Preview Latest Commit
Content Edit on Studio ↗︎ View Live Preview 82b094eeac672ef1458de5d55e9130b1e7edac1d
cloudflare-workers-and-pages[bot] commented 8 months ago

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: ecd1f33
Status: ✅  Deploy successful!
Preview URL: https://b448370b.nuxt-content-1il.pages.dev
Branch Preview URL: https://feat-imports-search-content.nuxt-content-1il.pages.dev

View logs

onmax commented 8 months ago

Right now, the title is getting rendered twice:

image

You can use frontmatter options to render just once as the rest of markdown files in the docs. Like this:

// 7.search-content.md
---
title: 'searchContent()'
description: 'A search function in your `content` directory.'
---

::alert{type="warning"}
This is an experimental feature, opt-in with the [`experimental.search` option](/get-started/configuration#search).
::

Cannot commit directly into the branch

Result

![image](https://github.com/nuxt/content/assets/22072217/4a5f21bb-31c9-4d51-8f12-9de636f43915)