https://github.com/anderspitman/tuplates-js
Commit working code; not templates
https://github.com/anderspitman/tuplates-js
Last synced: 8 months ago
JSON representation
Commit working code; not templates
- Host: GitHub
- URL: https://github.com/anderspitman/tuplates-js
- Owner: anderspitman
- Created: 2019-11-30T18:59:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-31T17:45:27.000Z (over 6 years ago)
- Last Synced: 2025-09-13T10:37:18.061Z (9 months ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
Tale as old as time. I started developing a new static site for
[patchbay.pub](https://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](https://css-tricks.com/the-simplest-ways-to-handle-html-includes/),
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
```bash
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:
```html
tuplates
My Awesome Content
```
```javascript
// 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:
```html
tuplates
My Awesome Header
My Awesome Content
```
```javascript
// 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.