Skip to content

PKuebler/metalsmith-twig

develop
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 

metalsmith-twig

A metalsmith Plugin for Twig based on justjohn/twig.js.

Install

  npm install metalsmith-twig

Configuration in metalsmith.json:

{
  "plugins": {
    "metalsmith-twig": {}
  }
}

Examples

Initialize (INIT):

var Metalsmith = require('metalsmith'),
	Twig = require('metalsmith-twig');

Metalsmith(__dirname)
	.use(twig())
	.build(function(err) {
		if (err) throw err;
	});

Options:

  • directory: (default: views) the directory for views.
  • global: (default: {}) global variables.
  • cache: (default: true) boolean if templatefiles cached.
  • twig: (default: undefined) overwrite the twig object.
  • allowInlineIncludes: (default: false) boolean if allow inline includes.
  • namespaces: (default: false) object with namespaces key => value (see twig.js project for more details).

Files

Source file src/index.md:

---
view: layout.html
title: The title
---
The Content

View

View views/layout.html:

<!doctype html>
<html>
	<head>
		<title>{{title}}</title>
	</head>
	<body>
		{{contents}}

		{{relativePath}}css/style.css
	</body>
</html>

Docs

Contributors

The MIT License (MIT)