docpad-plugin-coffeemugg v2.0.2

CoffeeMugg Plugin for DocPad

Adds support for CoffeeMugg to HTML compilation to DocPad

Convention: .html.coffee

Advantages over docpad-plugins-coffeecup:

• can use nodejs libraries i.e. require
• can create global custom tags via config
• clean debug code

Install

npm install --save docpad-plugin-coffeemugg

##Example usage

# templateData and docpad variables are accessed via @context
@div ->
	@p "I am a paragraph"
	@raw "<p> This is unescaped, raw HTML </p>"
	@text "<< This will be escaped ! >>"

Configure

Compress

By default we compress the output for all environments except the development environment. Set the format option to either true or false to change this (true formats nicely, false compresses).

Available Options

plugins:
	coffeemugg:
		options:
			# The output HTML will be formatted all pretty. 
			# **Default: false**
			format:		false
			
			# The "text" values are automatically HTML escaped. 
			# **Default: true** (use '@raw' tag for unescaped text.)
			autoescape: true
			
			# Array of plugins
			# They are functions that take a context as argument 
			# or can be strings that will be passed to require()
			plugins:	[]	

Plugin Examples

Can be an array of functions or require() locations

[
	(context) ->
		context["showFruits"] = (fruits) ->
			@ul ->
				for fruit in fruits
					@li fruit

	"src/code/mytag" # would specify require("src/code/mytag")
]

Plugins in separate files and to be loaded via require should be exported in the usual nodejs fashion:

module.exports =
	(context) ->
		context["showFruits"] = (fruits) ->
			@ul ->
				for fruit in fruits
					@li fruit

History

You can discover the history inside the History.md file

Contributing

You can discover the contributing instructions inside the Contributing.md file

License

Licensed under the incredibly permissive MIT License Copyright © 2013+ Stringz Solutions Ltd Copyright © 2013+ Peter Flannery