html-inject-meta
Advanced tools
Readme
Stream meta tags into html
Add metadata tags to a stream of html so that it looks pretty when you share it. See: indexhtmlify#5.
$ npm i html-inject-meta
html-inject-meta is designed to just work without much configuration, but allows overrides when necessary. The input must be valid html containing head and title tags. Insertion of the meta tags is not idempotent. Used without any arguments, the command line version looks for the nearest package.json. For example:
$ html-inject-meta < input.html
Given package.json:
{
"name": "html-inject-meta",
"description": "Stream meta tags into html",
"author": "Ricky Reusser"
}
and given a minimal html input
<!doctype html>
<html>
<head>
<title>-</title>
</head>
<body>
</body>
</html>
it produces the output:
<!doctype html>
<html>
<head>
<title>html-inject-meta</title>
<meta name="application-name" content="html-inject-meta">
<meta name="subject" content="Stream meta tags into html">
<meta name="abstract" content="Stream meta tags into html">
<meta name="twitter:title" content="html-inject-meta">
<meta name="description" content="Stream meta tags into html">
<meta name="twitter:description" content="Stream meta tags into html">
<meta name="author" content="Ricky Reusser">
<meta name="twitter:creator" content="Ricky Reusser">
<meta property="og:title" content="html-inject-meta">
<meta property="og:description" content="Stream meta tags into html">
<meta property="article:author" content="Ricky Reusser">
</head>
<body>
</body>
</html>
If you don't want to pollute your package.json with metadata for sharing, you can override the defaults by adding a html-inject-meta field to your package.json, e.g:
{
"name": "html-inject-meta",
"description": "My npm package description",
"author": "Ricky Reusser",
"html-inject-meta": {
"name": "My html-inject-meta demo",
"description": "Here's a neat demo",
"url": "http://html-inject-meta.github.io",
"author": "Ricky Reusser",
"image": "http://rawgit.com/rreusser/html-inject-meta/master/images/screenshot.png"
}
}
Even better, use it with indexhtmlify:
$ browserify index.js | indexhtmlify | html-inject-meta > index.html
To override the nearest package.json with your own input JSON:
$ html-inject-meta --input=mydata.json < input.html
You can disable json input with --no-input and instead specify fields on the command line:
$ html-inject-meta --no-input --title="My page!" --description="A description..." --author="My Name" < input.html
If you need further customization or more specificity, look in the code to see the precise logic. PRs with improvements are welcome!
require('html-inject-meta')([data])Returns a transform stream that applies to a stream of html the changes specified in data. The format of data identically matches the format of package.json that is read by the command line version, including the optional html-inject-meta field.
NB: My only use-case for this module is for building static pages. I've done my best to escape entities so that scrapers handle the meta tags well. Escaping via the entities module is too strong so that entities show up in the scraped data. Instead I've escaped &, ", < and > which should provide basic sanitization, but you should exercise caution if passing end-user data through to a publicly distributed page. I'm not willing to assert that malicious injection is absolutely impossible. But realistically it seems fine to me and not like the intended use case anyway. I mean why would you construct your own malicious package.json? I just feel like it's important to be transparent about this. Please don't hesitate to file an issue or PR with any issues or concerns.
This module is heaviliy inspired by and works great with indexhtmlify. Many thanks to Dima Yv for the initial inspiration.
© 2016 Ricky Reusser. MIT License.
FAQs
Stream meta tags into html
The npm package html-inject-meta receives a total of 1 weekly downloads. As such, html-inject-meta popularity was classified as not popular.
We found that html-inject-meta demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.