Plugin to configure Structured Data for Docusaurus sites
This plugin will generate Structured Data for your Docusaurus site, compliant with schema.org.
The plugin will generate the following types of structured data, and include them in the <head> of your site using the JSON-LD format:
Organization- augmented using data fromthemeConfig.structuredData.organizationWebSite- augmented using data fromthemeConfig.structuredData.websiteWebPage- dynamically generated for each pageBreadcrumbList- dynamically generated for each page
Docusaurus generated microdata for
BreadcrumbListis removed by this plugin in favor of the corresponding JSON-LD data.
Organization and WebSite can be extended using the themeConfig.structuredData object based upon properties provided (e.g. you can add any schema.org compliant properties for Organization and WebSite and these will be automatically included in your structured data for each page).
WebPage structured data is dynamically generated for each page, and includes the following properties:
name- sourced from pagetitleurl- page urldescription- sourced fromdescriptionin the page frontmattermainEntityOfPage- sourced fromsiteConfig.urlheadline- sourced fromsiteConfig.titledateModified- sourced from the build datedatePublished- sourced fromthemeConfig.structuredData.website.datePublished
BreadcrumbList structured data is dynamically generated for each page based upon the page route.
this plugin uses the
postBuildlifecycle hook to generate the structured data for each page, and inject it into the<head>of the page. It is only invoked uponyarn buildornpm run buildcommands being run.
Article structured data is automatically generated by this plugin for blog articles, including calcualting wordCount and including author data.
NPM
npm i @stackql/docusaurus-plugin-structured-dataYARN
yarn add @stackql/docusaurus-plugin-structured-dataAdd to plugins in docusaurus.config.js:
{
plugins: [
'@stackql/docusaurus-plugin-structured-data',
...
]
}Update themeConfig in the docusaurus.config.js file, the following shows mandatory properties:
{
...,
themeConfig: {
structuredData: {
excludedRoutes: [], // array of routes to exclude from structured data generation, include custom redirects here
verbose: boolean, // print verbose output to console (default: false)
featuredImageDimensions: {
width: number,
height: number,
},
authors:{
author_name: {
authorId: string, // unique id for the author - used as an identifier in structured data
url: string, // MUST be the same as the `url` property in the `authors.yml` file in the `blog` directory
imageUrl: string, // gravatar url
sameAs: [] // synonymous entity links, e.g. github, linkedin, twitter, etc.
},
},
organization: {}, // Organization properties can be added to this object
website: {}, // WebSite properties can be added to this object
webpage: {
datePublished: string, // default is the current date
inLanguage: string, // default: en-US
},
breadcrumbLabelMap: {} // used to map the breadcrumb labels to a custom value
}
},
...
}Below is an example of a docusaurus.config.js file with the themeConfig.structuredData object populated with all available properties:
structuredData: {
excludedRoutes: [
'/providers',
],
verbose: true,
featuredImageDimensions: {
width: 1200,
height: 627,
},
authors:{
'Jeffrey Aven': {
authorId: '1',
url: 'https://www.linkedin.com/in/jeffreyaven/',
imageUrl: 'https://s.gravatar.com/avatar/f96573d092470c74be233e1dded5376f?s=80',
sameAs: [
'https://www.amazon.com/stores/Jeffrey-Aven/author/B0BSP78VVL',
'https://developers.google.com/community/experts/directory/profile/profile-jeffrey-aven',
'https://www.linkedin.com/in/jeffreyaven/',
'https://www.crunchbase.com/person/jeffrey-aven',
'https://github.com/jeffreyaven',
'https://dev.to/jeffreyaven',
],
},
},
organization: {
sameAs: [
'https://twitter.com/stackql',
'https://www.linkedin.com/company/stackql',
'https://github.com/stackql',
'https://www.youtube.com/@stackql',
'https://hub.docker.com/u/stackql',
],
contactPoint: {
'@type': 'ContactPoint',
email: 'info@stackql.io',
},
logo: {
'@type': 'ImageObject',
inLanguage: 'en-US',
'@id': 'https://stackql.io/#logo',
url: 'https://stackql.io/img/stackql-cover.png',
contentUrl: 'https://stackql.io/img/stackql-cover.png',
width: 1440,
height: 900,
caption: 'StackQL - your cloud using SQL',
},
address: {
'@type': 'PostalAddress',
addressCountry: 'AU', // https://en.wikipedia.org/wiki/ISO_3166-1
postalCode: '3001',
streetAddress: 'Level 24, 570 Bourke Street, Melbourne, Victoria',
},
duns: '750469226',
taxID: 'ABN 65 656 147 054',
},
website: {
inLanguage: 'en-US',
},
webpage: {
inLanguage: 'en-US',
datePublished: '2021-07-01',
},
breadcrumbLabelMap: {
'developers': 'Developers',
'functions': 'Functions',
'aggregate': 'Aggregate',
'datetime': 'Date Time',
'json': 'JSON',
'math': 'Math',
'string': 'String',
'command-line-usage': 'Command Line Usage',
'getting-started': 'Getting Started',
'language-spec': 'Language Specification',
're': 'Regular Expressions',
}
},