Tuplates NPM | npm.io

Introduction

Tale as old as time. I started developing a new static site for patchbay.pub. At first it was just a single page. But of course eventually I needed to add a header. And of course HTML doesn't have a way to include another HTML file, because why would that be useful?

tuplates is a simple way to template your static sites, without creating a dependency on your templating tool. Rather than replacing your template tags, it works by replacing lines between your template tags. This means that both your template and code live together in your files. When you need to make a change, you update the fragment and re-run tuplates, and it replaces the old code. This way you can check your actual code into source control, rather than your templates.

The name comes from "update templates".

Installation

npm install -g tuplates

Usage

Create a tuplates directory containing your fragments as files. You can name them whatever you want.

project_directory/
  index.html
  index.js
  tuplates/
    header.html
    footer.html
    data.txt

Insert tuplate tags as comments in your code:

<!-- index.html -->
<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>tuplates</title>

  </head>

  <body>
    <!-- tuplate_start(header.html) -->
    <!-- tuplate_end() -->

    <main>
      <h1>My Awesome Content</h1>
    </main>

    <!-- tuplate_start(footer.html) -->
    <!-- tuplate_end() -->
  </body>

</html>

// index.js
console.log("Hi there");

// tuplate_start(data.js)
// tuplate_end()

console.log(data);

Run the tuplates command in the directory above the tuplates directory. It will walk the directory and replace the lines between the tags with the tuplates.

After running once, the source files look like this:

<!-- index.html -->
<!doctype html>
<html>
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>tuplates</title>

  </head>

  <body>
    <!-- tuplate_start(header.html) -->
    <!-- tuplates/header.html -->
    <div class='header'>
      <h1>My Awesome Header</h1>
    </div>
    
    
    <!-- tuplate_end() -->

    <main>
      <h1>My Awesome Content</h1>
    </main>

    <!-- tuplate_start(footer.html) -->
    <!-- tuplates/footer.html -->
    <div class='footer'>
      <h1>Awesome Footer</h1>
    </div>
    
    <!-- tuplate_end() -->
  </body>

</html>

// index.js
console.log("Hi there");

// tuplate_start(data.js)
// tuplates/data.js
const data = {
  a: 1,
  b: 2,
  c: 3,
};

// tuplate_end()

console.log(data);

If you re-run it again, the result is the same, even though there's already code between the tuplate tags. It simply replaces whatever is in there (if there is anything).

Note that this README was partially generated with tuplates (see the Markdown tuplates in this project's tuplates directory). Unfortunately it takes some manual intervention to work, in part because tuplates doesn't currently support nesting.

@everything-registry/sub-chunk-2986 @infinitebrahmanuniverse/nolb-tup

4 years ago

4 years ago

4 years ago

4 years ago