Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docpad/docpad-plugin-assets

DocPad plugin to provide assets with content-based unique names
https://github.com/docpad/docpad-plugin-assets

docpad-plugin

Last synced: 2 months ago
JSON representation

DocPad plugin to provide assets with content-based unique names

Host: GitHub
URL: https://github.com/docpad/docpad-plugin-assets
Owner: docpad
License: other
Created: 2013-08-24T23:56:09.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2023-12-31T11:26:34.000Z (about 1 year ago)
Last Synced: 2024-10-13T01:36:28.972Z (3 months ago)
Topics: docpad-plugin
Language: CoffeeScript
Homepage:
Size: 365 KB
Stars: 3
Watchers: 14
Forks: 2
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: Contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

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:

``` html

```

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

``` html

```

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.