vuepress-plugin-open-graph
v1.15.0
Published
VuePress plugin for generating open graph meta tags
Downloads
94
Maintainers
Readme
vuepress-plugin-open-graph
VuePress v2 plugin for generating open graph meta tags to improve SEO.
Installation
npm install --save vuepress-plugin-open-graph
Usage
Add plugin to your VuePress config:
import { openGraphPlugin } from 'vuepress-plugin-open-graph'
export default {
plugins: [
openGraphPlugin({
/* options */
}),
],
}
That's all. Just use frontmatter options in your Markdown files:
---
title: Post title
description: Post description
date: Post publish date
image: URL to post preview
---
Options
host
Type:
string
Required:
true
Details:
The domain name where the current site is deployed, the plugin needs this option to work.
defaultImage
Type:
string
Required:
false
Details:
Link to default open graph image. This image will be used unless otherwise specified.
twitterCard
Type:
'summary' | 'summary_large_image'
Required:
false
Details:
Twitter card type for a beautiful visual display of the tweet with post link. Read more.
twitterSite
Type:
string
Required:
false
Details:
Twitter username of your website.
Contribution
Pull requests are welcome.