Add option to set additional meta tags

faucet-pipeline · Sep 19, 2024 · 3c5cc73 · 3c5cc73
1 parent 73ac8c5
commit 3c5cc73
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,8 @@ unreleased
 
 significant changes for end users:
 
+* allow to set additional meta tags via the `meta` configuration:
+    * expects an object, with the keys being the `name` and the values being the `content`
 * we no longer bundle the --serve and --live-serve dependencies - you will be asked to install them
 * reduce faucet dependencies
 * update all dependencies

diff --git a/example/aiur.config.js b/example/aiur.config.js
@@ -2,6 +2,9 @@
 
 exports.title = "Example Styleguide";
 exports.language = "en";
+exports.meta = {
+	robots: "noindex"
+};
 
 exports.vendor = {
 	styles: [{

diff --git a/lib/generate_layout.js b/lib/generate_layout.js
@@ -9,6 +9,7 @@ module.exports = async (navigation, manifest) => {
 		<title>${page.title || ""}</title>
 		<meta name="description" content="${page.description || ""}">
 		<meta name="viewport" content="width=device-width,initial-scale=1">
+		${page.meta}
 		<link href="${manifest.get("style-aiur.css")}" rel="stylesheet">
 	</head>
 	<body id="aiur">

diff --git a/lib/page.js b/lib/page.js
@@ -2,11 +2,11 @@ let { repr } = require("faucet-pipeline-core/lib/util");
 let colonParse = require("metacolon");
 
 module.exports = class Page {
-	constructor(slug, sourcePath, children, { language, title, description }, dataPath) {
+	constructor(slug, sourcePath, children, { language, title, description, meta }, dataPath) {
 		this.slug = slug || "";
 		this.sourcePath = sourcePath;
 		this.children = children || null;
-		this.config = { language, title, description };
+		this.config = { language, title, description, meta };
 		this.dataPath = dataPath;
 	}
 
@@ -27,13 +27,18 @@ module.exports = class Page {
 		this.heading = headers.title;
 		this.title = [headers.title, this.config.title].filter(x => x).join(" | ");
 		this.description = headers.description || this.config.description;
+		this.meta = this.buildMeta();
 		this.status = headers.status;
 		this.version = headers.version;
 		this.tags = headers.tags;
 		this.body = body;
 		return this;
 	}
 
+	buildMeta() {
+		return Object.entries(this.config.meta || {}).map(x => `<meta name="${x[0]}" content="${x[1]}">`).join("\n");
+	}
+
 	toString() {
 		let filepath = repr(this.sourcePath, false);
 		let suffix = this.body ? " resolved" : "";

diff --git a/test/expectations/atoms/button/index.html b/test/expectations/atoms/button/index.html
@@ -5,6 +5,7 @@
 		<title>Button</title>
 		<meta name="description" content="interactive widget">
 		<meta name="viewport" content="width=device-width,initial-scale=1">
+		<meta name="robots" content="noindex">
 		<link href="/style-aiur.css" rel="stylesheet">
 	</head>
 	<body id="aiur">

diff --git a/test/expectations/atoms/index.html b/test/expectations/atoms/index.html
@@ -5,6 +5,7 @@
 		<title>Atoms</title>
 		<meta name="description" content="">
 		<meta name="viewport" content="width=device-width,initial-scale=1">
+		<meta name="robots" content="noindex">
 		<link href="/style-aiur.css" rel="stylesheet">
 	</head>
 	<body id="aiur">

diff --git a/test/expectations/atoms/strong/index.html b/test/expectations/atoms/strong/index.html
@@ -5,6 +5,7 @@
 		<title>strong</title>
 		<meta name="description" content="pretty strong component">
 		<meta name="viewport" content="width=device-width,initial-scale=1">
+		<meta name="robots" content="noindex">
 		<link href="/style-aiur.css" rel="stylesheet">
 	</head>
 	<body id="aiur">

diff --git a/test/expectations/index.html b/test/expectations/index.html
@@ -5,6 +5,7 @@
 		<title>My Style Guide</title>
 		<meta name="description" content="">
 		<meta name="viewport" content="width=device-width,initial-scale=1">
+		<meta name="robots" content="noindex">
 		<link href="/style-aiur.css" rel="stylesheet">
 	</head>
 	<body id="aiur">

diff --git a/test/fixtures/aiur.config.js b/test/fixtures/aiur.config.js
@@ -1,5 +1,9 @@
 "use strict";
 
+exports.meta = {
+	robots: "noindex"
+};
+
 exports.pages = {
 	"": "./welcome.md",
 	atoms: {