google / docsy

A set of Hugo doc templates for launching open source content.
https://docsy.dev
Apache License 2.0
2.63k stars 904 forks source link

Added Support for Canonical page link in <head> #2032

Open iArchitSharma opened 5 months ago

iArchitSharma commented 5 months ago

This PR fixes #2010 #1537

this code generates a canonical link tag for a webpage based on the value of the canonical_url parameter in the content file's front matter. If the parameter is not defined, it falls back to the permalink of the page, ensuring that search engines understand the preferred URL for the page.

fekete-robert commented 5 months ago

Hi, thanks for the PR! I think this functionality should go directly into layouts/partials/head.html, or into a separate partial that's included in head.html. The head-end hook is not a good place for it, because that's a placeholder file and many projects override it with their own code.

chalin commented 5 months ago

Hi @iArchitSharma - it looks like you copied the file that I put together for the OTel.io site. Is that the case? If so, then that file is a partial experimental design (I still have work to do on it), and it isn't suitable, in it's current form, for inclusion in Docsy yet.

iArchitSharma commented 5 months ago

@fekete-robert, thanks for the info. I'll move this functionality to head directly then.

iArchitSharma commented 5 months ago

Yes, @chalin, I copied this from the OTel.io site. Although when I tested it, it seemed to work as intended. What improvements are needed here? I would love to help