Features

Getting Started

NodeJS

  npm install @oothkoo/seo-js

Browser

<scriptsrc="dist/seo-X.X.X.min.js"type="text/javascript"></script>

Initialisation options

Example :

importSeofrom'@oothkoo/seo-js'varseo=newSeo({debug:true,headSelector:'head',ignoreEmptyTagValue:true})

Register (tag, link and meta) SEO tags

Seo.use(config)

Example :

seo.use({name:'name',// meta configuration ameselector:'name',// dom selector (.class, #id etc..)template:'<template>{value}</template>'// html template})

Seo.tag(name)

Example :

// Register 'title' tag and produces <title>{value}</title>seo.use(seo.tag('title'))seo.use(seo.tag(['author','section']))

Seo.metaName(name)

Example :

// Register 'title' tag and produces <meta name="title" content="{value}" />seo.use(seo.metaName('title'))seo.use(seo.metaName(['keywords','description']))

Seo.metaProperty(name)

Example :

// Register 'og:title' tag and produces <meta name="og:title" content="{value}" />seo.use(seo.metaProperty('og:title'))seo.use(seo.metaProperty(['og:site_name','og:description']))

Seo.link(name)

Example :

// Register 'favicon' tag and produces <link rel="favicon" href="{value}" />seo.use(seo.link('favicon'))seo.use(seo.link(['icon','robots']))

Seo.clearMetas()

Example :

seo.clearMetas()

Seo.clearTerms()

Example :

seo.clearTerms()

Seo.updateTerms(terms)

Example :

// Setting terms for templatingseo.updateTerms({'title':"Seo.js - A beautiful example",'description':"Seo example page description",'website':"https://www.oothkoo.com"})

Seo.clear()

Example :

seo.clear()

Seo.update(metas, only)

Example :

// Setting terms for templatingseo.update({'title':"{title}",// Using terms 'title' for value'description':"{description}",// Using terms 'description' for value'website':"https://www.oothkoo.com"})

Complete example

// When page content is loadedwindow.addEventListener('DOMContentLoaded',function(){// Initialize Seo libraryvarseo=newSeo({debug:true})// Register basic page metasseo.use(seo.tag('title'))seo.use(seo.metaName(['description','keywords']))seo.use(seo.metaLink('canonical'))// Register Open Graph page metasseo.use(seo.metaProperty(['og:type','og:site_name','og:title','og:url','og:description','og:image','og:image:width','og:image:height']))// Register Twitter page metasseo.use(seo.metaName(['twitter:card','twitter:site','twitter:creator','twitter:domain','twitter:url','twitter:image','twitter:title','twitter:description','twitter:label1','twitter:data1','twitter:label2','twitter:data2']))// Register Slack page metasseo.use(seo.metaName(['slack-app-id']))// Setting terms for templatingseo.updateTerms({'name':"SlugBay",'title':"Seo - A beautiful example",'description':"SlugBay helps you centralise and better manage all your resources, and discover new interesting material more quickly",'domain':"slugbay.com",'website':"https://www.slugbay.com",'image':"https://www.slugbay.com/pictures/opengraph.png",'username':"@slugbay"})// Update all current registered metasseo.update({'title':"{title}",'description':"{description}",'keywords':"example keyword seo js",'canonical':"{website}",'og:type':"website",'og:title':"{title}",'og:site_name':"{name}",'og:url':"{website}",'og:description':"{description}",'og:image':"{image}",'og:image:width':"640",'og:image:height':"280",'twitter:card':"summary_large_image",'twitter:site':"{username}",'twitter:creator':"{username}",'twitter:domain':"slugbay.com",'twitter:url':"{website}",'twitter:image':"{image}",'twitter:title':"{title}",'twitter:description':"{description}",'slack-app-id':"A2UTWA5PT"})})

Donations