bolighed-hexty v1.2.0
Hexty
A minimalistic tool for text replacement in HTML.
Install
npm i bolighed-hexty -DExample
There is a working example in the example folder.
Let's create the config file. It will contains the config object and the files list, both constants must be exported, like in the example.
For example in this case the index.html page will use the index.texts.js file.
textly.config.js
const path = require('path');
const files = [
{
path: path.resolve(__dirname, "./index.html"),
text_path: path.resolve(__dirname, "./index.texts.js")
}
];
module.exports = files;or text_path could be also an object
const path = require('path');
const { texts, texts2 } = require("./index.texts.js");
const files = [
{
path: path.resolve(__dirname, "./index.html"),
text_path: texts
}
];
module.exports = files;Let's create the index.texts.js file, which is a map of placeholder and text files
index.texts.js
const texts = {
"message-text": "Hello World in a text",
"message-html": "<h2>Something else in good old html</h2>",
"another-section-html": "<h2>another section</h2>",
"message-md": "### hello this is markdown ++"
}
module.exports = texts;The html tags with attribute data-textly having values matching the keys in index.texts.js. It is important if your text contains HTML your key must finish with -html and if contains Markdown it must finish -md.
Placeholder ending with -x will not be checked.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<h1>Texty example</h1>
<p data-hexty="message-text">Hello World in a text</p>
<p data-hexty="message-text">Hello World in a text</p>
<li data-hexty="message-html" class="plum"><h2>Something else in good old html</h2></li>
<li data-hexty="message-html" class="plum"><h2>Something else in good old html</h2></li>
<li data-hexty="message-md" class="plum"><h3>hello this is markdown ++</h3></li>
<li data-hexty="message-md" class="plum"><h3>hello this is markdown ++</h3></li>
</body>
</html>At last, let's create the index.js file that glues everything together.
index.js
const config = require('./hexty.config');
require('bolighed-hexty')(config);If there are some errors they will be displayed like so
otherwise
CLI usage
You can use the tool from the command line like so:
hexty --config hextly.config.js