Structured Data
HelpGuides automatically adds structured data (JSON-LD) and SEO meta tags to your published pages. They help search engines and AI answer engines understand what each page is about, who published it and when. There's nothing to set up.
Schema types
| Schema type | Added to | Includes |
|---|---|---|
Article | Every documentation article | Headline, publish date, URL, your site as the author, and a link to the article's Markdown version |
FAQPage | Articles that contain FAQ blocks | Each FAQ block's question and answer |
BlogPosting | Blog posts | Headline, description, publish and modified dates, featured image, keywords, the author as a Person, and your site as the publisher with its logo |
ProfilePage | Author pages | The author as a Person with their name, URL, photo and bio |
Article
For example, this article includes:
The author's name is your project's Title from Settings → General.
FAQPage
When an article contains FAQ blocks, HelpGuides adds an FAQPage entry listing each question and its answer as plain text. Search engines can show these as expandable questions in results, so use FAQ blocks for the questions your readers actually ask.
BlogPosting and ProfilePage
Blog posts use BlogPosting instead of Article, and credit the post's author as a person when one is assigned. Author pages use ProfilePage. See Blog Projects and Authors and Author Pages.
Meta tags
Each article's <head> also includes:
| Tag | Purpose |
|---|---|
description | The article's Meta Description, set in the editor under Advanced → SEO |
canonical | The article's preferred URL, using your canonical domain and your trailing slash setting, so search engines don't treat copies as duplicates |
Open Graph (og:title, og:description, og:url, og:image and others) | The title, description and featured image shown when the article is shared on social media and in chat apps |
article:published_time, article:modified_time | When the article was published and last updated |
robots with noindex, nofollow | Added only when Allow Indexing is off for the article, or the article isn't published |
alternate links | Point to the article's Markdown (.md), plain HTML (.html) and JSON versions, and to your RSS feed |
Category pages have their own canonical URL, description and Open Graph tags, and the 404 page is always marked noindex.
Check your structured data
Paste an article's URL into Google's Rich Results Test or the Schema Markup Validator to see exactly what search engines read.