Add ability to set description meta tag #778
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds the ability to set a description meta tag by introducing a new description generator, updating front matter parsing, and propagating the description through various views and templates.
- Introduces a DescriptionGenerator class to create meta descriptions from Markdown.
- Updates front matter parsing and ViewModel definitions to include a description.
- Integrates the new description into the HTML output and adds a dependency in HtmlWriter.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/Elastic.Markdown/Slices/DescriptionGenerator.cs | New utility to generate a description for meta tags from Markdown. |
| src/Elastic.Markdown/Myst/FrontMatter/FrontMatterParser.cs | Adds a new YAML field for description parsing. |
| src/Elastic.Markdown/Slices/_ViewModels.cs | Updates view models to include the Description property. |
| src/Elastic.Markdown/Slices/HtmlWriter.cs | Uses the new description generator to set the meta description. |
| src/Elastic.Markdown/Assets/main.ts | Imports additional HTMX extension for head support. |
| src/Elastic.Markdown/DocumentationGenerator.cs | Passes the new DescriptionGenerator to HtmlWriter. |
| src/Elastic.Markdown/Slices/Index.cshtml | Updates the layout view to output the description. |
| src/Elastic.Markdown/Slices/Layout/_Head.cshtml | Updates the head markup to include the description meta tag. |
Comments suppressed due to low confidence (1)
src/Elastic.Markdown/Slices/DescriptionGenerator.cs:80
- Add a check to ensure that 'paragraphText' is not empty before accessing its last character to avoid a potential IndexOutOfRangeException in list item processing.
var lastChar = paragraphText[^1];
Mpdreamz
reviewed
Mar 19, 2025
| } | ||
|
|
||
| #pragma warning disable IDE0060 | ||
| private static void ProcessIncludeBlock(IncludeBlock include, StringBuilder description) => Console.WriteLine("Not implemented: ProcessIncludeBlock"); |
There was a problem hiding this comment.
Suggested change
| private static void ProcessIncludeBlock(IncludeBlock include, StringBuilder description) => Console.WriteLine("Not implemented: ProcessIncludeBlock"); | |
| private static void ProcessIncludeBlock(IncludeBlock include, StringBuilder description) {} |
Or use our logging infrastructure.
There was a problem hiding this comment.
You could use discard parameters to not have the #pragma
There was a problem hiding this comment.
Yeah. Interestingly, I had an error saying something like Duplicate arg "_" something something.
But I'm going to clean this up and just add a comment instead.
Mpdreamz
approved these changes
Mar 19, 2025
# Conflicts: # src/Elastic.Markdown/Slices/HtmlWriter.cs # src/Elastic.Markdown/Slices/_ViewModels.cs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
You can now add the
descriptionfield to the FrontMatter block on every document.If the field is not present, then it will be autogenerated based on the content.