Plugins
Here's a list of all available DocPad plugins. If you've created a plugin, be sure to include it in this listing! :)
To install a plugin, run
docpad install #{thePluginName} inside your project directory. As an example, to install the eco plugin, you would run docpad install ecoTo uninstall a plugin, run
docpad uninstall #{thePluginName} inside your project directory.In older versions of DocPad, you would run
npm install --save docpad-plugin-#{thePluginName} to install, and npm uninstall --save docpad-plugin-#{thePluginName} to uninstall.Complete listings of DocPad plugins can be found at:
Below is a curated listing of plugins.
These are plugins that add support for extra markups and languages to DocPad:
CoffeeScript Templating Engines
HAML-Like Templating Engines
Moustache Templating Engines
Other Templating Engines
- vash - Supports Vash, an implementation of the Razor template syntax for JavaScript, to anything
.anything.vash
- cmds - Adds some shell scripting fun. Supports
.anything.bash|.anything.sh|.anything.ps1|.anything.cmd
These are plugins that add extra functionality to DocPad:
- assets - Change URL of asset files to contain hash of contents, allowing for effective caching whilst enabling cache busting when contents change
- associatedfiles - Lets you easily associate files to a particular document, and then grab the collection for them
- authentication - Handles authentication and login functionality via social login (ie google, facebook, twitter or github) for your docpad application. Protects pages from unauthenticated users.
- browserifybundles - Add configuration to your DocPad configuration file to create browserify bundles of your scripts
- csv - Adds support for CSV data mapping. The comma seperated data files work just like a database, map from column 1 to column 2
- datefromfilename - Automaticaly set the
datemeta-data property by determining it from the document's filename - heapdumper - Generates a heapdump snapshot for chosen DocPad event(s), viewable in the Chrome profiler
- jsonfragment - Writes each documents content without layout and its meta data into a separate
.jsonfile for quick loading via AJAX. - navlinks - Adds the ability to generate a navigation bar for documents with links to the next and previous document of a specified collection.
- paged - Adds multiple page support to documents allowing you to render one document out to many pages
- raw - Copies all files in the
/rawdirectory to/outwithout going through DocPad's generation process. Useful for files that cause out of memory/speed issues when placed in/staticdirectory. - copy - Alternative to raw pluging with performace optimizations. Copies all files in the
/rawdirectory to/outwithout going through DocPad's generation process. Useful for files that cause out of memory/speed issues when placed in/staticdirectory. - related - Scans your documents
tags: 'tag1', 'tag2'metadata to produce a listing of related documents - scheduling - Schedules content so that it is not rendered out before the
datespecified in the content's meta-data. - shortcodes - Adds various Wordpress style shortcodes (e.g.,
[video id="123"]) to simplify template writing. - text - Render
templateDataproperties without needing template engine, useful for abstraction in configuration files - imagin - Alternative to thumbails plugin with support for
rawandcopyplugins for performance optimization. Manages thumbnail generation of your image files. - tinylivereload - A LiveReload plugin that doesn't alter your HTML. Works with the Chrome/Firefox LiveReload extensions.
- umd - Wrap specified JavaScript documents in the Universal Module Definition (UMD) allowing them to run in AMD, Require.js, CommonJS/Node.js and Vanilla environments automatically
DocPad's plan from the very beginning has been to be interface agnostic. This means that we will be able to utilise existing interfaces, customer interfaces, and decoupled interfaces. Allowing us to always utilise the best experiences for everyone involved.
DocPad's plugin/extension infrastructure supports existing coupled interfaces by importing their data directly into the DocPad Database. So if you love using Tumblr, WordPress, Medium, MongoDB, or GitHub repos for your content, you don't have to give them up. Just install the importer plugin for them, and DocPad will import the data from that service into the DocPad database for rendering.
- downloader - Download (and optionally extract) files into your project, used in the Bootstrap Skeleton to pull in Bootstrap
- tumblr - Imports Tumblr data directly into your DocPad Database, used in the Syte Skeleton to pull in Tumblr data
DocPad's plugin/extension infrastructure supports custom Admin Interfaces tightly coupled to the DocPad experience. So far we have the following extensions that add Admin Interfaces to DocPad:
DocPad's plugin/extension infrastructure supports existing decoupled interfaces by providing plugin/extension adapters to the interface allowing the interface to interact directly with the DocPad Database, or theoretically any backend providing an interface was made for it. So far we have the following extensions that add Decoupled Interfaces to DocPad:
- Use Prose with DocPad to create a Wiki - Tutorial on how to use Prose.io as an Admin Interface for DocPad
- WebWrite's InlineGUI (not yet ready) - Edit your content from any backend with this inline editing interface
- Edit & Deploy with GitHub.com & GHpages Plugin - Wiki on how to use GitHub.com to edit your DocPad website and then DocPad's
ghpagesplugin to deploy to GitHub Pages.
These are miscellaneous things that you can do with DocPad:
Last modified 2yr ago