Include project name and version in og:title
#261
Merged
Conversation
This file contains 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
This adds `ENV["HORO_PROJECT_NAME"]` and `ENV["HORO_BADGE_VERSION"]` to the `og:title` meta tag. The intent is to differentiate titles between different versions of the documentation. Note that `og:title` is typically an abridged form of the page title. `og:title` values longer than ~60 characters may be truncated. The string " (Ruby on Rails v7.0.0)" is 23 characters, leaving ~40 characters for the full module name. Most public modules in the Rails API appear to fall within that limit. But even for those that don't, the project version and name will be truncated first, leaving `og:title` no worse than before.
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.
This adds
ENV["HORO_PROJECT_NAME"]andENV["HORO_BADGE_VERSION"]to theog:titlemeta tag. The intent is to differentiate titles between different versions of the documentation.Note that
og:titleis typically an abridged form of the page title.og:titlevalues longer than ~60 characters may be truncated. The string " (Ruby on Rails v7.0.0)" is 23 characters, leaving ~40 characters for the full module name. Most public modules in the Rails API appear to fall within that limit. But even for those that don't, the project version and name will be truncated first, leavingog:titleno worse than before.