Skip to content

docs(seo): titles that carry the search terms, and a social card - #42

Merged
franklupo merged 1 commit into
masterfrom
docs/seo
Oct 7, 2026
Merged

franklupo merged 1 commit into
masterfrom
docs/seo

Conversation

@franklupo

Copy link
Copy Markdown
Member

Titles

The <title> of a page ended with the site name, for example Errors | cv4pve-api-java: nothing a search for Proxmox VE would match. With the titleSuffix option of theme 2.8.0 it ends with what the library is: Errors | Proxmox VE API client for Java.

Getting started, Connection and Troubleshooting, the pages people land on from a search, have a title of their own in the frontmatter (head); the title in the menu and at the top of the page stays short. A Connection page that already had a descriptive title is left as it is.

Social card

docs/public/og.png (1200x630) is the image shown when a page of the documentation is shared. Theme 2.8.0 adds og:image and twitter:image to every page when that file is there; until now the pages asked for a large card (twitter:card) and had no image to show.

The image is written by a script of the theme from the texts of the home page (product name, hero title, description) and the product icon, so it can be rewritten when the home page changes:

cd docs
node node_modules/@corsinvest/cv4pve-docs-theme/tools/og-image.mjs

Checked

Site built with theme 2.8.0: one <title> per page, og:image and twitter:image on every page with the address of the published image, og.png in the built site.

Pages ended their <title> with the site name: "Errors | cv4pve-api-java". They now end with what the library is, "Errors | Proxmox VE API client for Java" (titleSuffix of the theme), and Getting started, Connection and Troubleshooting have a title of their own. docs/public/og.png is the image shown when a page is shared. Theme 2.8.0.
@franklupo
franklupo merged commit 1baad70 into master Oct 7, 2026
3 checks passed
@franklupo
franklupo deleted the docs/seo branch October 7, 2026 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant