npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

super-html-compiler

v1.4.1

Published

An HTML compiler that will combine multiple html files into one that can be loaded in a browser.

Downloads

8

Readme

Description

This project allows to compile separated HTML files into a single HTML file.

Usage

To use this module you need to separate your HTML structure to a single component per file. After that you need to use the <static-import>PATH</static-import> to place a component in it's place.

Then run:

npm install -g super-html-compiler
html-compile input.html output.html

OR

npm install super-html-compiler --save-dev
npx html-compile input.html output.html

Example

file structure:

* (project root / cwd)
|
|--- * (src)
|    |
|    |--- * (_header.html)
|    |
|    |--- * (index.template.html)
|
|--- * (out)

src/_header.html:

<header>
    <a href="someLink">Link1</a>
    <a href="someLink2">Link2</a>
</header>

src/index.template.html:

<html>
    <head>
        <title>Example</title>
    </head>
    <body>
        <static-import>./_header.html</static-import>
        <div class="body">blah blah blah</div>
    </body>
</html>

To generate out/index.html run:

html-compile src/index.template.html out/index.html

out/index.html:

<html>
    <head>
        <title>Example</title>
    </head>
    <body>
        <header>
            <a href="someLink">Link1</a>
            <a href="someLink2">Link2</a>
        </header>
        <div class="body">blah blah blah</div>
    </body>
</html>

All available tags and their uses

| name | description | |--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| | static-import | Allows to include external resources to the final html. (Note: The resources are simply copy-pasted) | | static-requirement | Add all contents of this tag to the head of the final html (if a head exists). Can be used to define requirements inside of external resources. | | static-requirement-placeholder | Specify a location to put all requirements from tags | | static-placeholder | Allows to replace content dynamically with a tag. REQUIRED ATTRIBUTES: name | | static-parameter | Specifies the contents to use in place of a placeholder. This tag is usable ONLY inside a tag. REQUIRED ATTRIBUTES: name | | static-attribute | Allows to set the attribute of the parent to whatever value is between the tags. REQUIRED ATTRIBUTES: name, OPTIONAL ATTRIBUTES: remove-on |

CLI options

| short name | long name | default | description | |------------|-----------------------------------|---------|-------------------------------------------------------------------| | -p | --project-root | . | The path to prepend to all paths in <static-*> tags | | | --allow-duplicated-requirements | false | Wether to allow the specification of a requirement multiple times |

JS options

Class: Compiler

| name | type | default | description | |-------------------------------|-----------|-------------|-------------------------------------------------------------------| | cwd | string | | The path to prepend to all paths in <static-*> tags | | allow_duplicated_requirements | boolean | false | Wether to allow the specification of a requirement multiple times |

GRUNT options

Task: super_html_compiler

| name | type | default | description | |-------------------------------|-----------|---------|-------------------------------------------------------------------| | cwd | string | . | The path to prepend to all paths in <static-*> tags | | allow_duplicated_requirements | boolean | false | Wether to allow the specification of a requirement multiple times |