Repository navigation
docs: add SEO metadata and page descriptions - #115
Merged
Merged
Conversation
- Site description, social preview card and project structured data (repository, MIT license, TypeScript, VS Code). - A search-friendly description on every page; the generated commands, settings and catalogue pages get theirs from scripts/generate-docs.ts. - Pin the shared hugo-theme to b0b7836, which adds JSON-LD, robots.txt with the sitemap and the page description check.
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
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.
Summary
Search and link preview metadata for https://boxboxjason.github.io/achievements/.
docs/hugo.toml): a home page description, a social preview card (docs/static/images/social.png, 1200x630, rendered with hugo-theme'stools/social-card.mjs), and project structured data: repository, MIT license, TypeScript, Visual Studio Code. Astaticmount was added, since this site lists its mounts explicitly.descriptionof 50 to 160 characters. The generated Commands, Settings and Achievements catalogue pages get theirs fromscripts/generate-docs.ts, sonpm run docs:checkstill covers them.b0b7836onmain, in bothdocs/go.modand the workflow. It adds:SoftwareSourceCodeon the home page,TechArticleon the other pages;robots.txtpointing at the sitemap;docs/staticis not in the VSIX (npm pack --dry-run).Test plan
npm run check-types,npm run lintandnpm run docs:checkpass.docs:checkfails when a generated description is edited by hand.--panicOnWarning. The home and page<meta name="description">tags are the written ones;og:imageandtwitter:imageresolve under/achievements/; the JSON-LD parses.