seo-tags-helper

v1.0.1

Published

2 years ago

Generate Meta Tags for SEO

Downloads

0High
0Medium
0Low

pc12

seo meta Twitter Cards Facebook Open Graph

SEO Tags Helper

Generates Meta Tags for SEO, Facebook Open Graph, Twitter Cards

Installation

npm i seo-tags-helper

Getting Started

// Node.js
const seoHelper = require('seo-tags-helper')

Usage

seoHelper.print( meta = {}, config = {} )

Returns the constructed HTML Output String, using data specified in meta.

meta An object containing data for meta tags, values specified here override the default values (if specified)
Refer Here for a list of possible keys for meta
config An object containing configuration options, values specified here override the global configuration
Refer Here for a list of possible configuration options

seoHelper.setConfig( config = {} )

Sets Global Configuration

Refer Here for a list of possible configuration options

seoHelper.setDefault( defaultMeta = {} )

Sets default values for meta tags data, default values are used as fallbacks for keys not specified in seoHelper.print

Refer Here for a list of possible keys for defaultMeta

Example with ejs


// Controller
const seoHelper = require("seo-tags-helper");

// Set Default Value, acts as fallback
seoHelper.setDefault({ title: "Dummy Title" });

// Set Global Config
seoHelper.setConfig({ enableRobots: false, enableFacebookOg: false });

module.exports.dummy = (req, res) => {

	const metaData = {
		title: "Lorem Ipsum",
		favicon: "https://picsum.photos/60",
		desc: "Lorem ipsum dolor sit amet consectetur adipisicing elit. ",

		twitterTitle: "Twitter - Dummy Title",
		twitterDesc:  "Twitter - Lorem ipsum dolor sit amet consectetur adipisicing elit",
		twitterImage: "https://picsum.photos/400",
		twitterUrl: "https://www.lipsum.com/",
	};

		// Pass Data To view
		res.render("view", { metaData, seoHelper });
	});
};


<!-- View -->

<html>

  <head>
    <!-- Pass config as the second argument, overrides global config -->
    <%- seoHelper.print(metaData, { useGeneralAsDefault: false } ) %>
  </head>

  <body>
    Hello World
  </body>

</html>

Configuration Options

Meta Tags Data Reference

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme