Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A general purpose template cli
JavaScript
tree: 62cbd4d34c

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.tpl
bin
node_modules
test
.npmignore
LICENSE.mkd
README.mkd
package.json
tpl.js

README.mkd

tpl

a general purpose template cli

Installation

npm install tpl or npm install -g tpl

Usage

Simple

To parse a file and apply a template, simply provide the file as an argument.

tpl hello-world.mkd

This will do several things.

  1. Look for a .tpl directory in the current working directory, if none exists look for one in the parent directory, in the parent's parent directory and so on. If there's no .tpl directory all the way up to the root, use the default .tpl in the installation directory.
  2. Use the configuration defined in ./tpl/conf.json.
  3. Look for a parser for the file extension (.mkd). If none was found, use the default parser.
  4. Read and parse the file.
  5. Look if the file defined a template, which should be used for its rendering. If not, use the default rendering.
  6. Print the rendered document.

If you want to save the output, you can use

tpl hello-world.mkd > hello-world.html

Use custom configuration

For information on how to customize the behavior of tpl, look at the wiki.

Bugs and Issues

If you encounter any bugs or issues, feel free to open an issue at github.

License

This package is licensed under the MIT license.

Something went wrong with that request. Please try again.