Find file
Fetching contributors…
Cannot retrieve contributors at this time
157 lines (120 sloc) 4.35 KB
# The DocPad Configuration File
# It is simply a CoffeeScript Object which is parsed by CSON
docpadConfig = {
# =================================
# Template Data
# These are variables that will be accessible via our templates
# To access one of these within our templates, refer to the FAQ:
# Specify some site properties
# The production url of our website
url: ""
# Here are some old site urls that you would like to redirect from
oldUrls: [
# The default title of our website
title: "Kitchensink Skeleton for DocPad"
# The website description (for SEO)
description: """
A DocPad Skeleton useful for showcasing different features and functionality of DocPad. Implemented using Twitter Bootstrap.
# The website keywords (for SEO) separated by commas
keywords: """
place, your, website, keywoards, here, keep, them, related, to, the, content, of, your, website
# The website author
author: "Benjamin Lupton"
# The website's email
email: ""
# Styles
styles: [
# Scripts
scripts: [
# -----------------------------
# Helper Functions
# Get the prepared site/document title
# Often we would like to specify particular formatting to our page's title
# we can apply that formatting here
getPreparedTitle: ->
# if we have a document title, then we should use that and suffix the site's title onto it
if @document.title
"#{@document.title} | #{@site.title}"
# if our document does not have it's own title, then we should just use the site's title
# Get the prepared site/document description
getPreparedDescription: ->
# if we have a document description, then we should use that, otherwise use the site's description
@document.description or @site.description
# Get the prepared site/document keywords
getPreparedKeywords: ->
# Merge the document keywords with the site keywords
@site.keywords.concat(@document.keywords or []).join(', ')
# =================================
# DocPad Collections
nifties: ->
markups: ->
pages: ->
posts: ->
# =================================
# DocPad Plugins
haml: 'xml'
less: 'css'
stylus: 'css'
md: 'markdown'
# =================================
# DocPad Events
# Here we can define handlers for events that DocPad fires
# You can find a full listing of events on the DocPad Wiki
# Server Extend
# Used to add our own custom routes to the server before the docpad routes are added
serverExtend: (opts) ->
# Extract the server from the options
{server} = opts
docpad = @docpad
# As we are now running in an event,
# ensure we are using the latest copy of the docpad configuraiton
# and fetch our urls from it
latestConfig = docpad.getConfig()
oldUrls = or []
newUrl =
# Redirect any requests accessing one of our sites oldUrls to the new site url
server.use (req,res,next) ->
if in oldUrls
res.redirect(newUrl+req.url, 301)
# =================================
# Environments
# DocPad's default environment is the production environment
# The development environment, actually extends from the production environment
# The following overrides our production url in our development environment with false
# This allows DocPad's to use it's own calculated site URL instead, due to the falsey value
# This allows <%- @site.url %> in our template data to work correctly, regardless what environment we are in
url: false
# Export our DocPad Configuration
module.exports = docpadConfig