docpad-plugin-assets

Assets Plugin for DocPad

DocPad plugin to change URL of asset files to contain hash of contents, allowing for effective caching whilst enabling cache busting when contents change

Usage

Change URL of asset files to contain hash of contents, allowing for effective caching whilst enabling cache busting when contents change.

This plugin enables the function @asset(), which takes a single string argument of the asset to manage. For example, if you have some HTML which looks like this:

<img src="/images/myimage.png" />

Then to put the asset under then plugin's control you would change this to:

<img src="<%- @asset('/images/myimage.png') %>" />

And that's it!

By default the plugin will leave the path along and replace the name of the file with it's hash. Continuing on from the above example, with the defaults the output URL will be something like /images/3992a5c4177710abf7d1e90b91636b26cbac138b.png. There are two options which you can tweak to change this default output.

• retainPath: if set to 'no' then this will remove any leading path from the URL and put the asset in the root directory. In the above case the output URL will be /3992a5c4177710abf7d1e90b91636b26cbac138b.png
• retainName: if set to 'yes' then this will retain the name of the original file, and append the hash to it. In the above case the output URL will be /images/myimage-3992a5c4177710abf7d1e90b91636b26cbac138b.png

Implementation Notes

Please ensure that all assets use absolute path names, otherwise this plugin might not operate correctly.

Install

Install this DocPad plugin by entering docpad install assets into your terminal.

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the Contributing.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Jim McDonald — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions
• Jim McDonald — view contributions

Discover how you can contribute by heading on over to the Contributing.md file.

License

Unless stated otherwise all works are:

• Copyright © 2013+ Jim McDonald

and licensed under:

• MIT License