import-tag
v1.0.1
Published
<h1 align="center">import-tag</h1>
Downloads
1
Maintainers
christopherwk210Readme
Node script that transforms HTML to allows you to use <import src="./path/to/html"> syntax. This allows you to generate static HTML files from separate, smaller components.
Installation
$ npm i import-tag --saveUsage
Usage inside of Node will look something like this at the very least:
const path = require('path');
const importTag = require('import-tag');
(async () => {
try {
let compiledHtml = await importTag( path.join(__dirname, './index.html') );
console.log(compiledHtml);
} catch(e) {
console.log(`Error: ${e}`);
}
})();Inside of your HTML file, usage looks like this:
<html>
<body>
<h1>Hello World</h1>
<import src="./test.html">
</body>
</html>The import tag does not have a closing tag, and the src attribute must point to a relative path. Nested imports are supported, so in this example test.html can also contain <import src=""> tags, and so on.
Note:
Each import tag
srcuses the relative directory of the current HTML file. Always use paths relative to the current file!
Example
Given these files:
<!-- index.html -->
<html>
<body>
<h1>Hello World</h1>
<import src="./components/content.html">
</body>
</html><!-- content.html -->
<p>Welcome to my great site! It's nothing fancy.</p>
<import src="./picture.html"><!-- picture.html -->
<img src="./path/to/some/pic.jpg" alt="An interesting image">Assuming this structure:
.
├── components
│ ├── content.html
│ └── picture.html
└── index.htmlThe output will be:
<!-- index.html -->
<html>
<body>
<h1>Hello World</h1>
<!-- content.html -->
<p>Welcome to my great site! It's nothing fancy.</p>
<!-- picture.html -->
<img src="./path/to/some/pic.jpg" alt="An interesting image">
</body>
</html>Caveats
File paths inside of any other element are not transformed. This means that any paths you use inside of an imported HTML file will be relative to the parent file. Imported HTML files just become one compiled file output, so please take that in to account when writing your JS and CSS as well.