SEO

About 2 min

vuepress-theme-hope provides SEO enhancements via the built-in @vuepress/plugin-seo.

Info

Configure the plugin via the plugins.seo option in the theme options. To disable this feature, set plugins.seo to false.

Default Behavior

The plugin operates out of the box. It extracts page content, site configuration, theme configuration, and page Frontmatter to automatically generateOpen Graph Protocol (OGP) and JSON-LD 1.1 tags.

Default OGP Generation

Meta Name	Value
`og:url`	`themeConfig.hostname` + `path`
`og:site_name`	`siteConfig.title`
`og:title`	`page.title`
`og:description`	`page.frontmatter.description` \|\| auto-generated (when `autoDescription` is `true`)
`og:type`	`"article"`
`og:image`	`themeConfig.hostname` + `page.frontmatter.image` \|\| first image in page \|\| `fallbackImage`
`og:updated_time`	`page.git.updatedTime`
`og:locale`	`page.lang`
`og:locale:alternate`	Other languages included in `siteData.locales`
`twitter:card`	`"summary_large_image"` (if image exists)
`twitter:image:alt`	`page.title` (if image exists)
`article:author`	`page.frontmatter.author` \|\| `themeConfig.author`
`article:tag`	`page.frontmatter.tags` \|\| `page.frontmatter.tag`
`article:published_time`	`page.frontmatter.date` \|\| `page.git.createdTime`
`article:modified_time`	`page.git.updatedTime`

Default JSON-LD Generation

Property Name	Value
`@context`	`"https://schema.org"`
`@type`	`"NewsArticle"`
`headline`	`page.title`
`image`	images in page \|\| `themeConfig.hostname` + `page.frontmatter.image` \|\| `fallbackImage`
`datePublished`	`page.frontmatter.date` \|\| `page.git.createdTime`
`dateModified`	`page.git.updatedTime`
`author`	`page.frontmatter.author` \|\| `themeConfig.author`

Setting Tags Directly

Configure the head option in the page Frontmatter to inject specific tags into the page <head>.

---
head:
  - - meta
    - name: keywords
      content: SEO plugin
---

This configuration outputs: <meta name="keywords" content="SEO plugin" />.

Customizing Generation

Page Type Resolution

By default, all non-home pages generated from Markdown files are treated as articles. Use the plugins.seo.isArticle option to provide custom logic for identifying articles.

(page: Page) => boolean;

Note

For non-article content types (e.g., books, music), handle the custom data generation via the ogp, jsonLd, and customHead options below.

OGP Customization

Use plugins.seo.ogp to mutate the default OGP object before output.

function ogp(
  /** OGP Object inferred by plugin */
  ogp: SeoContent,
  /** Page Object */
  page: Page,
  /** VuePress App */
  app: App,
): SeoContent;

Example usage for overriding the og:image property with a custom banner field from Frontmatter:

seoPlugin({
  ogp: (ogp, page) => ({
    ...ogp,
    "og:image": page.frontmatter.banner || ogp["og:image"],
  }),
});

JSON-LD Customization

Use plugins.seo.jsonLd to mutate the default JSON-LD object.

function jsonLd(
  /** JSON-LD Object inferred by plugin */
  jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema,
  /** Page Object */
  page: Page,
  /** VuePress App */
  app: App,
): ArticleSchema | BlogPostingSchema | WebPageSchema;

To specify the primary URL for content deployed across multiple domains or paths, set plugins.seo.canonical. Pass a string to prepend a base URL, or a function (page: Page) => string | null for programmatic control.

Tips

If your site is accessible via http://example.com/docs/ and https://www.example.com/docs/ (primary), setting plugins.seo.canonical to https://www.example.com/docs/ instructs search engines to index the primary URL exclusively.

Custom `<head>` Tags

Use plugins.seo.customHead to manually modify the <head> tags array. This is useful for fulfilling search engine specific requirements.

function customHead(
  /** Head tag config */
  head: HeadConfig[],
  /** Page Object */
  page: Page,
  /** VuePress App */
  app: App,
): void;

RDFa 1.1 Support

The theme implements rich media structure support following theRDFa 1.1 specification.

Tips

Verify the structured data of your site using the Google Rich Results Test.

Reference Links

Changelog

3/13/26, 12:40 AM

View All Changelog

2d7bd-docs: update docson 3/13/26
2a19e-docs: tweakson 6/4/25
bdfcb-docs: update linkson 5/30/24
0fe94-feat: use official copy-code, feed, seo and sitemap plugin (#3879)on 2/1/24
fa8af-docs: tweakson 12/27/23
181f5-docs(seo2): update docs, close #3781on 12/24/23
0fffa-chore: improve typeson 11/10/23
2f38e-docs(theme): update docson 11/9/23
794f9-chore: update depson 7/6/23
2a306-docs: fix typos, grammar, and other minor issues (#3049)on 4/21/23
b77b7-docs: update iconon 1/19/23
8174c-docs(theme): use fontawesomeon 1/18/23
c8d60-docs: deploy docs at netlify (#2624)on 1/3/23
20f60-docs: fix typoson 6/2/22
e4e4a-docs: fix typos and broken linkon 5/21/22
ad023-docs: fix typoson 5/19/22
fd395-docs: update related docson 5/3/22
a214d-feat(seo2): add canonical options, close #1663on 4/10/22
60053-docs: update headingon 3/24/22
716f9-chore: add demoson 3/24/22
aaec0-feat(seo2): improve generate logic, fix #1591on 3/18/22
0c093-docs: update docson 3/12/22
f6ff0-docs(theme): update categories and tagson 2/26/22
37324-docs(theme): update docson 2/22/22
04b8a-docs: improve markdownon 2/15/22
3c199-docs(theme): add docson 2/15/22
d953e-feat(seo2): refine options and update docson 2/14/22
6ed69-docs: update docson 2/8/22
281f5-docs(seo2): add docson 1/27/22

Contributors

Mr.Hope

Nan Huang