Add ability to set canonical base url #776
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 support for specifying a canonical base URL throughout the documentation site. Key changes include:
- Introducing a new nullable property CanonicalBaseUrl in BuildContext and updating related view models.
- Adding a new CLI parameter for canonicalBaseUrl and wiring it through the documentation generation process.
- Incorporating the canonical URL tag in the rendered HTML head section.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Elastic.Markdown/BuildContext.cs | Adds a new property to hold the canonical base URL |
| src/Elastic.Markdown/Slices/_ViewModels.cs | Updates view models to include the canonical base URL property |
| src/docs-builder/Cli/Commands.cs | Introduces the canonicalBaseUrl CLI parameter and propagates it |
| src/Elastic.Markdown/Slices/HtmlWriter.cs | Incorporates trimming for the canonical base URL before usage |
| src/Elastic.Markdown/Slices/Index.cshtml | Passes canonicalBaseUrl to the view |
| src/Elastic.Markdown/Slices/Layout/_Head.cshtml | Renders the canonical link tag based on the canonical base URL |
Comments suppressed due to low confidence (1)
src/Elastic.Markdown/Slices/Layout/_Head.cshtml:13
- Consider using a URL join method or ensuring proper slash handling when concatenating Model.CanonicalBaseUrl and Model.CurrentDocument.Url to avoid malformed canonical URLs.
<link rel="canonical" href="@(Model.CanonicalBaseUrl + Model.CurrentDocument.Url)">
Mpdreamz
requested changes
Mar 19, 2025
src/Elastic.Markdown/BuildContext.cs
Outdated
| public bool AllowIndexing { get; init; } | ||
|
|
||
| // This property is used for the canonical URL | ||
| public string? CanonicalBaseUrl { get; init; } |
|
|
||
| @if (Model.CanonicalBaseUrl is not null) | ||
| { | ||
| <link rel="canonical" href="@(Model.CanonicalBaseUrl + Model.CurrentDocument.Url)"> |
There was a problem hiding this comment.
Suggested change
| <link rel="canonical" href="@(Model.CanonicalBaseUrl + Model.CurrentDocument.Url)"> | |
| <link rel="canonical" href="@(new Uri(Model.CanonicalBaseUri, Model.CurrentDocument.Url))"> |
src/docs-builder/Cli/Commands.cs
Outdated
| Force = force ?? false, | ||
| AllowIndexing = allowIndexing ?? false | ||
| AllowIndexing = allowIndexing ?? false, | ||
| CanonicalBaseUrl = canonicalBaseUrl |
Mpdreamz
approved these changes
Mar 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.