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

feat: support for searching code blocks #1797

Merged
merged 2 commits into from
Feb 4, 2025
Merged

Conversation

chenjiahan
Copy link
Member

Summary

This PR adds a new search.codeBlocks option.

If enabled, the search index will include code block content, which allows users to search code blocks.

import { defineConfig } from 'rspress/config';

export default defineConfig({
  search: {
    codeBlocks: true,
  },
});

Default value

This default value is false to align with other search engines like Docsearch, see: https://docsearch.algolia.com/docs/docsearch-program/#can-you-index-code-samples.

If it works well, we may consider enabling it by default in the future.

Related Issue

resolve #1543

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copy link

netlify bot commented Feb 2, 2025

Deploy Preview for aquamarine-blini-95325f ready!

Name Link
🔨 Latest commit 084a5bc
🔍 Latest deploy log https://app.netlify.com/sites/aquamarine-blini-95325f/deploys/67a16b59c8e168000834c4e2
😎 Deploy Preview https://deploy-preview-1797--aquamarine-blini-95325f.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 95 (🟢 up 1 from production)
Accessibility: 97 (no change from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@chenjiahan chenjiahan requested a review from SoonIter February 4, 2025 01:36
@SoonIter SoonIter merged commit dfcaf89 into main Feb 4, 2025
7 checks passed
@SoonIter SoonIter deleted the search_code_blocks_0202 branch February 4, 2025 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Code blocks are searchable.
2 participants