Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: mention that searchContent is an experimental feature #2505

Merged
merged 2 commits into from Jan 17, 2024

Conversation

antfu
Copy link
Member

@antfu antfu commented Jan 16, 2024

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

mention that searchContent is an experimental feature

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

Copy link

nuxt-studio bot commented Jan 16, 2024

βœ… Live Preview ready!

Name Edit Preview Latest Commit
Content Edit on Studio β†—οΈŽ View Live Preview 82b094e

Copy link

cloudflare-pages bot commented Jan 16, 2024

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
Copy link

onmax commented Jan 16, 2024

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

@farnabaz farnabaz merged commit e6a1b06 into main Jan 17, 2024
3 checks passed
@farnabaz farnabaz deleted the feat/imports-search-content branch January 17, 2024 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants