OGGEN - OpenGraph metadata generator


> Dynamically generate your open-graph metadata for your html files (with typescript support).

Usage

Install package:

``sh


npm

npm install @it-tools/oggen

yarn

yarn install @it-tools/oggen

pnpm

pnpm install @it-tools/oggen
`

Import:

`js
// ESM or typescript
import { generateMeta } from '@it-tools/oggen';

// CommonJS
const { generateMeta } = require('@it-tools/oggen');
`

API

$3

`typescript
import { generateMeta } from '@it-tools/oggen';

const metadata = generateMeta(
{
title: 'IT-Tools',
description: 'Lorem ipsum',
image: {
url: 'https://example.com/image.png',
alt: 'The image alt text',
width: 600,
height: 400,
},
locale: 'en_US',
siteName: 'IT-Tools',
// Put here whichever key you want to generate the meta with
//...
},
// Optional configuration
{
indentation: 2, // default: 0
indentWith: ' ', // default: ' ' (two spaces)
generateTwitterCompatibleMeta: true, // default: false
},
);

console.log(metadata);

/*


















*/
`

Please refer to ogp.me for the metadata semantic

$3

It support array of data

`typescript
const metadata = generateMeta({
music: {
author: [
{ name: 'Person 1 ', city: 'London' },
{ name: 'Person 2', city: 'Paris' },
],
tags: ['Tag 1', 'Tag 2'],
},
});

console.log(metadata);

/*









*/
`

$3

You can put your extra twitter thing under the twitter key

`typescript
const metadata = generateMeta(
{
title: 'IT-Tools',
description: 'Lorem ipsum',
twitter: {
title: 'Title for twitter',
card: 'summary_large_image',
},
},
{
generateTwitterCompatibleMeta: true, // default: false
},
);

console.log(metadata);

/*







// <-- present because of 'generateTwitterCompatibleMeta'


*/
`

Development

- Clone this repository
- Install dependencies using pnpm install
- Run interactive tests using pnpm dev`

Credits

Coded with ❤️ by Corentin Thomasset.

License

This project is under the MIT license.