-
Notifications
You must be signed in to change notification settings - Fork 1
/
docpad.coffee
137 lines (107 loc) · 4.6 KB
/
docpad.coffee
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# 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: https://github.com/bevry/docpad/wiki/FAQ
templateData:
# Specify some site properties
site:
# The production url of our website
url: "http://test.rdaregistry.info"
# The default title of our website
title: "RDA Registry"
# The website description (for SEO)
description: """
This is the technical documentation for the Resource Description and Access (RDA) published vocabularies and element set.
"""
# The website keywords (for SEO) separated by commas
keywords: """
RDA, vocabularies, documentation, registry
"""
# The website author's name
author: "Jon Phipps"
# The website author's email
email: "[email protected]"
# Your company's name
copyright: "© American Library Association"
# 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
else
@site.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(', ')
plugins:
rss:
default:
collection: 'posts'
url: '/rss.xml' # optional, this is the default
# Collections
# ===========
# These are special collections that our website makes available to us
collections:
# For instance, this one will fetch in all documents that have pageOrder set within their meta data
pages: (database) ->
database.findAllLive({pageOrder: $exists: true}, [pageOrder:1,title:1])
# This one, will fetch in all documents that will be outputted to the posts directory
posts: (database) ->
database.findAllLive({relativeOutDirPath:'posts', pageOrder: $exists: false},[date:-1])
# This one, will fetch in all documents that will be outputted to the Elements directory
Elements: (database) ->
database.findAllLive({relativeOutDirPath:'Elements', pageOrder: $exists: false},[filename:1])
# This one, will fetch in all documents that will be outputted to the Elements directory
'Elements/en': (database) ->
database.findAllLive({relativeOutDirPath:'Elements/en', pageOrder: $exists: false},[filename:1])
languages: (database) ->
database.findAllLive({language: $exists: true},[language:1])
# =================================
# Server Configuration
# Port
# Use to change the port that DocPad listens to
# By default we will detect the appropriate port number for our environment
# if no environment port number is detected we will use 9778 as the port number
# Checked environment variables are:
# - PORT - Heroku, Nodejitsu, Custom
# - VCAP_APP_PORT - AppFog
# - VMC_APP_PORT - CloudFoundry
port: 9779 # default
# DocPad Events
# =============
# Here we can define handlers for events that DocPad fires
# You can find a full listing of events on the DocPad Wiki
events:
# 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 = latestConfig.templateData.site.oldUrls or []
newUrl = latestConfig.templateData.site.url
# Redirect any requests accessing one of our sites oldUrls to the new site url
server.use (req,res,next) ->
if req.headers.host in oldUrls
res.redirect 301, newUrl+req.url
else
next()
# Export our DocPad Configuration
module.exports = docpadConfig