Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rafaelrinaldi/html-meta-tags
Generate HTML meta tags from JSON data.
https://github.com/rafaelrinaldi/html-meta-tags
cli html javascript meta-tags nodejs open-graph twitter
Last synced: about 2 months ago
JSON representation
Generate HTML meta tags from JSON data.
- Host: GitHub
- URL: https://github.com/rafaelrinaldi/html-meta-tags
- Owner: rafaelrinaldi
- License: mit
- Created: 2017-09-09T21:31:07.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T00:40:41.000Z (about 2 years ago)
- Last Synced: 2024-10-12T17:42:56.698Z (3 months ago)
- Topics: cli, html, javascript, meta-tags, nodejs, open-graph, twitter
- Language: JavaScript
- Size: 162 KB
- Stars: 28
- Watchers: 3
- Forks: 4
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[url]: https://rinaldi.io
# html-meta-tags [](https://semaphoreci.com/rafaelrinaldi/html-meta-tags)
> Generate HTML meta tags from JSON data.
## Install
```sh
npm install html-meta-tags -g
```
## Usage
#### CLI
You can either pipe data from the standard input or specify a file path for the program.
```sh
$ html-meta-tags
Usage: html-meta-tags [options]
Example:
cat data.json | html-meta-tags
Options:
-v --version Display current program version
-h --help Display help and usage details
--no-charset Do not specify UTF-8 as document charset
--no-og Do not generate Open Graph meta tags
--no-twitter Do not generate Twitter meta tags
$ echo '
{
"title": "My Website",
"url": "https://mywebsite.com",
"keywords": ["blockchain", "infosec", "crypto"],
"description": "This is my personal website"
}' | html-meta-tags
```
#### Node.js
```js
var htmlMetaTags = require('html-meta-tags')
var data = require('./data.json')
console.log(htmlMetaTags(data))
```
## API
### htmlMetaTags(data, [options])
Returns an HTML string containing a representation of all meta tags from `data`.
#### data
Type: `Object`
Meta tags in object notation format.
* You can use arrays for comma-separated such as `keywords` or `viewport`.
* If a specific value for a prefixed key is specified it will take precedence over the default.
* Prefixed keys should have their own entry, `og:title` for example, should be represented as:
```js
{
og: {
title: 'value'
}
}
```
#### options
Type: `Object`
##### shouldIgnoreCharset
Type: `boolean`
Default: `false`
Whether or not it should render UTF-8 charset meta tag.
##### shouldIgnoreTwitter
Type: `boolean`
Default: `false`
Whether or not it should render Twitter specific meta tags.
##### shouldIgnoreOpenGraph
Type: `boolean`
Default: `false`
Whether or not it should render Open Graph specific meta tags.
## License
MIT © [Rafael Rinaldi][url]
---