Skip to content

Fix: Truncate MkDocs search results preview #6485

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix: Truncate MkDocs search results preview #6485

wants to merge 1 commit into from

Conversation

@codeEvolveZenith345
Copy link
Contributor

@codeEvolveZenith345 codeEvolveZenith345 commented Nov 1, 2025

Proposed Changes

  • Truncate search result previews to 3 lines (about 100 characters) via custom CSS in home.css
  • Update mkdocs.yml to ensure the CSS file is loaded
  • Improves search result usability by preventing display of excessive content

Fixes #6316
close #6316

@netlify
Copy link

netlify bot commented Nov 1, 2025 •
edited
Loading

✅ Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 9831102
🔍 Latest deploy log https://app.netlify.com/projects/knative/deploys/690edea509ab010008e6e6cf
😎 Deploy Preview https://deploy-preview-6485--knative.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 1, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: codeEvolveZenith345 / name: codeEvolveZenith345 (9831102)

@knative-prow knative-prow bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 1, 2025
evankanderson
evankanderson reviewed Nov 3, 2025
View reviewed changes
@evankanderson
Copy link
Member

evankanderson commented Nov 3, 2025

/assign

@knative-prow
Copy link

knative-prow bot commented Nov 8, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: codeEvolveZenith345
Once this PR has been reviewed and has the lgtm label, please ask for approval from evankanderson. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@codeEvolveZenith345 codeEvolveZenith345 force-pushed the fix/truncate-search-result-preview branch from 4ef8e34 to 8a29917 Compare November 8, 2025 04:14
@knative-prow knative-prow bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 8, 2025
@codeEvolveZenith345 codeEvolveZenith345 force-pushed the fix/truncate-search-result-preview branch from 8a29917 to 48de9f0 Compare November 8, 2025 04:21
@knative-prow knative-prow bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 8, 2025
@codeEvolveZenith345
Fix search result truncation to improve scannability
9831102 
- Truncate search result previews to 3 lines maximum
- Improves user ability to scan and find relevant results quickly
- Prevents display of entire page content (e.g., 900 words) in search results

Signed-off-by: codeEvolveZenith345 <[email protected]>
@codeEvolveZenith345 codeEvolveZenith345 force-pushed the fix/truncate-search-result-preview branch from 1610e0d to 9831102 Compare November 8, 2025 06:09
@knative-prow knative-prow bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 8, 2025
@codeEvolveZenith345
Copy link
Contributor Author

codeEvolveZenith345 commented Nov 8, 2025

hey @evankanderson
I have fixed the issue and verified it in the preview
Screenshot 2025-11-08 113707
image

@codeEvolveZenith345
Copy link
Contributor Author

codeEvolveZenith345 commented Nov 8, 2025

@evankanderson
the truncation works perfectly, please tell me if I should change the styling...

@codeEvolveZenith345 codeEvolveZenith345 mentioned this pull request Nov 9, 2025
Open
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Leo6Leo Leo6Leo Awaiting requested review from Leo6Leo

@zainabhusain227 zainabhusain227 Awaiting requested review from zainabhusain227

@evankanderson evankanderson Awaiting requested review from evankanderson

Assignees

@evankanderson evankanderson

Labels

size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Truncate search results

2 participants

@codeEvolveZenith345 @evankanderson