docpad-plugin-associatedfiles
Advanced tools
DocPad plugin that fetches any associated files for our particular document
This plugin streamlines finding associated files for a particular document in DocPad, which is useful for:
docpad install associatedfiles
The way it works is by looking into src/files/associated-files/#{document.associatedFilesPath or document.basename} for files. Where associatedFilesPath is set in your document's meta data, and if it doesn't exist it will use the document's basename (e.g. the basename of my-holiday-2012.html.eco is my-holiday-2012). Any files inside that path will be associated to your document, and retrieveable by @getDocument().getAssociatedFiles()
Lets see how this works, we have the document src/documents/my-holiday-2012.html.eco:
---
title: My Holiday in 2012
---
<h2>Here are some great photos from our trip</h2>
<% for file in @getDocument().getAssociatedFiles().toJSON(): %>
<p>
<h3><%= file.title or file.name %></h3>
<img src="<%= file.url %>" title="<%= file.title or file.name %>" />
</p>
<% end %>
Then we will stick a few images inside our path: src/files/associated-files/my-holiday-2012. And we'll end up with the rendered result:
<h2>Here are some great photos from our trip</h2>
<p>
<h3>sweet-sweet-beach.jpg</h3>
<img src="/associated-files/my-holiday-2012/sweet-sweet-beach.jpg" title="sweet-sweet-beach.jpg" />
</p>
<p>
<h3>sweet-sweet-icecream.jpg</h3>
<img src="/associated-files/my-holiday-2012/sweet-sweet-icecream.jpg" title="sweet-sweet-icecream.jpg" />
</p>
The default configuration for this plugin is the equivalant of adding the following options to your DocPad configuration file:
plugins:
associatedfiles:
# The paths for the associated files.
associatedFilesPath: 'associated-files'
# Whether to use relative base paths for the document. This would
# use associated-files/subfolder/myarticle/image.jpg instead of
# associated-files/myarticle/image.jpg.
useRelativeBase: false
It is possible to override the default configuration on a per-template basis:
---
associatedFilesRelative: true
associatedFilesPath: './myfolder'
---
<% for file in @getDocument().getAssociatedFiles().toJSON(): %>
<p>
<h3><%= file.title or file.name %></h3>
<img src="<%= file.url %>" title="<%= file.title or file.name %>" />
</p>
<% end %>
Discover the release history by heading on over to the HISTORY.md file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md file.
Unless stated otherwise all works are:
and licensed under:
FAQs
DocPad plugin that fetches any associated files for our particular document
We found that docpad-plugin-associatedfiles demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.