gulp-seo
v1.0.2
Published
Adds social meta tags to your websites
Downloads
30
Maintainers
Readme
gulp-seo
Gulp plugin for adding social meta tags to your website
This Gulp plugin enables you to add meta tags to your website. Here is a simple example using gulp-seo
:
var gulpSeo = require('gulp-seo');
gulp.task('seo', function() {
return gulp.src('views/index.html')
.pipe(gulpSeo({
list: ['og', 'se', 'schema', 'twitter'],
meta: {
title: 'Title website',
description: 'Description website',
author: 'Maksym Blank',
keywords: ['website', 'with', 'meta', 'tags'],
robots: {
index: false, // true
follow: true // true
},
revisitAfter: '5 month', // 3 month
image: 'http://mywebsite.com/image.jpg',
site_name: 'My Website',
type: 'website'
}
}))
.pipe(gulp.dest('./views'));
});
API
gulpSeo([opts])
opts
(Object
): Options for adding Meta Tags.opts.list
(Array
): List of adding Meta Tags.- og : Open Graph Meta Tags
- se : Search Engine Meta Tags
- schema : Schema Meta Tags
- twitter : Twitter Meta Tags
opts.meta
(Object
): All desired Meta Tags
Options opts.meta
title
Your website's title.
Type: string
Required: true
Example:
<title>My Website</title>
description
Your website's description.
Type: string
Required: true
Example:
<meta name="description" content="Description of this personal website..">
site_name
If your object is part of a larger web site, the name which should be displayed for the overall site.
Type: string
Required: false
Example:
<meta name="og:site_name" content="Personal website">
keywords
Your website's keywords.
Type: string
, array
Required: false
Example:
<meta name="keywods" content="my new website, awesome website">
author
Your website's author.
Type: string
Required: false
Example:
<meta name="author" content="John Smith">
robots
Type: object
Required: false
Example:
<meta name="robots" content="noindex, follow">
revisitAfter
Type: string
Required: false
Example:
<meta name="revisit-after" content="3 month">
image
Type: string
Required: false
Example:
<meta name="og:image" content="http://mywebsite.com/image.jpg">
url
Type: string
Required: false
Example:
<meta name="og:url" content="http://mywebsite.com/">
type
Type: string
Required: false
Example:
<meta name="og:type" content="website">
contact
Type: string
Required: false
Example:
<meta name="contact" content="[email protected]">
abstract
Type: string
Required: false
Example:
<meta name="abstract" content="Small description of my website">
copyright
Type: string
Required: false
Example:
<meta name="copyright" content="name of owner">
rating
Valid Values: general | mature | restricted | 14 years | safe for kids
Type: string
Required: false
Example:
<meta name="rating" content="14 years">
webauthor
Type: string
Required: false
Example:
<meta name="webauthor" content="Maksym Blank">
video
Type: string
Required: false
Example:
<meta name="og:video" content="http://mywebsite.com/video">
locale
Type: string
Required: false
Example:
<meta name="og:locale" content="en_Us">
audio
Type: string
Required: false
Example:
<meta name="og:audio" content="http://mywebsite.com/audio">
Also See
- Open Graph - http://ogp.me
- Search Engine - https://www.metatags.org
- Twitter - https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/markup
- Schema - http://schema.org/