Pin the docs site config, and give it a favicon - #2224
Merged
Conversation
The site was running on GitHub's defaults, which take the title and description from the repo's name and description fields - so an edit in the repo settings UI quietly changed the site's metadata. Those are pinned now, along with the URL, which is what jekyll-seo-tag uses to build canonical and og:url. Also: strip_title, so the page title stops being printed twice (once in the theme's header banner, once as the heading it was derived from); jekyll-sitemap, which is not in the always-on GitHub Pages plugin set, for the sitemap.xml and robots.txt the site did not have; and a favicon built from the project logo, hooked up via the head-custom.html include the theme provides for exactly this. Claude-Session: https://claude.ai/code/session_01NxkjXSR7CSGzyw89tJJVtw
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The docs site has been running on GitHub's defaults. That mostly works - the always-on plugin set does real work for us (
jekyll-optional-front-matteris why front-matter-less markdown renders,jekyll-relative-linksis why inter-doc links resolve,jekyll-titles-from-headingsis where page titles come from) - but a few things fall out of it.Site metadata came from the repo settings UI.
jekyll-github-metadatafillssite.titlefrom the repo name andsite.descriptionfrom the repo description field, so editing the description on the repo page silently changed the site's<meta name="description">and its Open Graph tags. Both are pinned now, along withurl, which is whatjekyll-seo-taguses to build canonical andog:url.No sitemap.
jekyll-sitemapis not in the always-on set and has to be asked for;sitemap.xmlandrobots.txtboth 404 today. Opting in generates both.No favicon. The theme's head includes
head-custom.htmland ships a version with the favicon line commented out, so overriding that file is the intended hook. Built from the project logo. Modern browsers get the 256px PNG, everything else a 16/32/48.icoat the site root, where the browser's automatic/favicon.icoprobe finds it regardless of markup. Checked that it still reads at 16px on light and dark tab backgrounds.The page title was printing twice. The theme renders the page title in its header banner, and that title is derived from the page's first heading - which is still in the body.
titles_from_headings.strip_titledrops the heading from the body once it has been promoted. The banner is unaffected, and the markdown keeps its headings, so GitHub's own rendering is unchanged.Theme is unchanged (already Cayman).
There is no Ruby toolchain to hand, so this could not be rendered locally - worth a look on the deployed site once it lands.