Skip to content
This repository
Newer
Older
100755 144 lines (94 sloc) 10.397 kb
ab55c126 »
2012-08-26 Readme clean
1 # DocPad. Streamlined web development. [![Build Status](https://secure.travis-ci.org/bevry/docpad.png?branch=master)](http://travis-ci.org/bevry/docpad)
2c4dd58c »
2012-02-15 v3.2.4. Working on osx, windows, heroku. Working on node 0.4 and 0.6.…
2
ea4e760c »
2012-08-26 Cleaned and added some favourite tweets
3 Hi! I'm DocPad, I streamline the web development process and help close the gap between experts and beginners. I've been used in production by big and small companies for over a year and a half now to create [plenty of amazing and powerful web sites and applications](https://github.com/bevry/docpad/wiki/Showcase) quicker than ever before. What makes me different is instead of being a box to cram yourself into and hold you back, I'm a freeway to what you want to accomplish, just getting out of your way and allowing you to create stuff quicker than ever before without limits. Leave the redudant stuff up to me, so you can focus on the awesome stuff.
d14f3802 »
2011-05-12 0.6. Moved to CoffeeScript. Removed highlight.js
4
ab55c126 »
2012-08-26 Readme clean
5 Discover my features below, or skip ahead to the installation instructions to get started with a [fully functional pre-made website](https://github.com/bevry/docpad/wiki/Skeletons) in a few minutes from reading this.
1bfb7fef »
2011-03-23 More initial
6
0e917adc »
2012-08-26 Redid the readme
7 ## Features
cedea5c3 »
2011-10-06 New readme copy. Let me know what you think :-)
8
0e917adc »
2012-08-26 Redid the readme
9 ### Out of the box
1ec0de69 »
2012-02-08 Muwahahhaha. Added support for Ruby, ERuby, and PHP. WOOHOOO.
10
5c3a9cb2 »
2012-08-28 v6.6.0. Improvements.
11 - Competely file based meaning there is no pesky databases that need to be installed, and for version control you get to use systems like Git and SVN which you're already use to (You can still hook in remote data sources if you want, DocPad doesn't impose any limits on you, ever)
721ef2b6 »
2012-08-26 Readme clean up a bit
12 - Choose from plenty of community maintained [pre-made websites](https://github.com/bevry/docpad/wiki/Skeletons) to use for your next project instead of starting from scratch everytime
13 - Write your documents in any language, markup, templating engine, or pre-processor you wish (we're truly agnostic thanks to your plugin system). You can even mix and match them when needed by combining their extensions in a rails like fashion (e.g. `coffee-with-some-eco.js.coffee.eco`)
14 - Changes to your website are automatically recompiled through our built in watch system, saving you time
0e917adc »
2012-08-26 Redid the readme
15 - Add meta data to the top of your files to be used by templating engines to display non-standard information such as titles and descriptions for your documents
721ef2b6 »
2012-08-26 Readme clean up a bit
16 - Display custom listings of content with our powerful [Query Engine](https://github.com/bevry/query-engine/) available to your templating engines
0e917adc »
2012-08-26 Redid the readme
17 - Abstract out generic headers and footers into layouts using our nested layout system
721ef2b6 »
2012-08-26 Readme clean up a bit
18 - For simple static websites easily deploy your generated website to any web server like apache or github pages. For dynamic projects deploy them to servers like [heroku](http://www.heroku.com/) or [nodejitsu](http://nodejitsu.com/) to take advantage of custom routing with [express.js](http://expressjs.com/). [Deploy guide here](https://github.com/bevry/docpad/wiki/Hosting)
19 - Built-in server to save you from having to startup your own, for dynamic deployments this even supports things like clean urls, custom routes and server-side logic
20 - Robust architecture and powerful plugin system means that you are never boxed in unlike traditional CMS systems, instead you can always [extend DocPad](https://github.com/bevry/docpad/wiki/Extending) to do whatever you need it to do, and you can even write to bundle common custom functionality and distribute them through the amazing node package manager [npm](http://npmjs.org/)
21 - Built in support for dynamic documents (e.g. search pages, signup forms, etc.), so you can code pages that change on each request by just adding `dynamic: true` to your document's meta data (exposes the [express.js](http://expressjs.com/) `req` and `res` objects to your templating engine)
0e917adc »
2012-08-26 Redid the readme
22 - You can use it standalone, or even easily include it within your existing systems with our [API](https://github.com/bevry/docpad/wiki/API)
1ec0de69 »
2012-02-08 Muwahahhaha. Added support for Ruby, ERuby, and PHP. WOOHOOO.
23
6fdc4805 »
2012-04-20 More readme improvements
24
0e917adc »
2012-08-26 Redid the readme
25 ### With our amazing community maintained plugins
6fdc4805 »
2012-04-20 More readme improvements
26
721ef2b6 »
2012-08-26 Readme clean up a bit
27 - Use the [Live Reload](https://github.com/bevry/docpad-extras/tree/master/plugins/livereload) plugin to automatically refresh your web browser whenever a change is made, this is amazing
0e917adc »
2012-08-26 Redid the readme
28 - Pull in remote RSS/Atom/JSON feeds into your templating engines allowing you to display your latest twitter updates or github projects easily and effortlessly using the [Feedr Plugin](https://github.com/bevry/docpad-extras/tree/master/plugins/feedr/)
721ef2b6 »
2012-08-26 Readme clean up a bit
29 - Support for every templating engine and pre-processor under the sun, including but not limited to CoffeeScript, CoffeeKup, ECO, HAML, Handlebars, Jade, Less, Markdown, PHP, Ruby, SASS and Stylus - [the full listing is here](https://github.com/bevry/docpad/wiki/Plugins)
0e917adc »
2012-08-26 Redid the readme
30 - Use the [Partials Plugin](https://github.com/bevry/docpad-extras/tree/master/plugins/partials/) to abstract common pieces of code into their own individual file that can be included as much as you want
31 - Syntax highlight code blocks automatically with our [Pygments Plugin](https://github.com/bevry/docpad-extras/tree/master/plugins/pygments/)
721ef2b6 »
2012-08-26 Readme clean up a bit
32 - Get SEO friendly clean URLs with our [Clean URLs Plugin](https://github.com/bevry/docpad-extras/tree/master/plugins/cleanurls/) (dynamic deployments only)
33 - Lint your code automatically with our Lint Plugin - under construction, coming soon
34 - Concatenate and minify your JavaScript and CSS assets making page loads faster for your users with our Minify Plugin - under construction, coming soon
35 - Install common javascript libraries like jQuery, Backbone and Underscore directly from the command line - under construction, coming soon
36 - Automatically translate your entire website into other languages with our Translation Plugin - under construction, coming soon
37 - Add a admin interface to your website allowing you to edit, save and preview your changes on live websites then push them back to your source repository with the Admin Plugin - under construction, coming soon
38 - Pretty much if DocPad doesn't already do something, it is trivial to [write a plugin](https://github.com/bevry/docpad/wiki/Extending) to do it, seriously DocPad can accomplish anything, it never holds you back, there are no limits, it's like super powered guardian angel
39 - There are also [plenty of other plugins](https://github.com/bevry/docpad/wiki/Plugins) not listed here that are still definitely worth checking out! :)
1880748b »
2012-04-20 More readme improvements
40
41
ea4e760c »
2012-08-26 Cleaned and added some favourite tweets
42 ## People love DocPad
43
44 All sorts of people love DocPad, from first time web developers to even industry leaders and experts. In fact, people even migrate to DocPad from other systems as they love it so much. Here are some our [favourite tweets](https://twitter.com/#!/DocPad/favorites) of what people are saying about DocPad :)
45
46 [![Some favourite tweets about DocPad](https://raw.github.com/bevry/docpad/dev/docs/favs.gif)](https://twitter.com/#!/DocPad/favorites)
47
48
49
1880748b »
2012-04-20 More readme improvements
50
c1b7c7cb »
2011-05-10 Minor
51 ## Installing
dc382c26 »
2011-05-10 Update to readme
52
8d9b380a »
2012-06-24 Update master
53 1. [Install Node.js](https://github.com/bevry/community/wiki/Installing-Node)
a63518b5 »
2011-05-09 Updated installation instructions
54
6864fedf »
2011-07-07 whoops, still had the install mongodb requirement in the readme
55 1. Install DocPad
792badec »
2012-05-05 Added version number to install instructions.
56
6ef1ea41 »
2012-04-20 Greatly simplified the readme
57 ``` bash
0e917adc »
2012-08-26 Redid the readme
58 [sudo] npm install -fg docpad@6.5
6ef1ea41 »
2012-04-20 Greatly simplified the readme
59 [sudo] docpad install
60 ```
1bfb7fef »
2011-03-23 More initial
61
fe8f9f50 »
2012-07-12 Bumped DocPad version in readme, changed growl download link to the d…
62 1. If you also want growl notifications (OSX), then download and install the `GrowlNotify` tool from the [Growl Download Page](http://growl.info/downloads)
f3d24539 »
2011-11-13 Now uses Benjamin Lupton's watchr library for file watching, has supp…
63
44c4f769 »
2012-01-02 v2.6.0. Released fixes for #115. Updated for balupton -> bevry move. …
64 _Getting errors? [Try troubleshooting](https://github.com/bevry/docpad/wiki/Troubleshooting)_
c576f475 »
2011-09-16 added note about installing the cutting edge version
65
f3d24539 »
2011-11-13 Now uses Benjamin Lupton's watchr library for file watching, has supp…
66
67
6ef1ea41 »
2012-04-20 Greatly simplified the readme
68 ## Quick Start
cdf1a062 »
2012-02-15 more readme updates
69
0003d524 »
2012-04-20 More readme improvements
70 Once you've installed, you can get started with a brand new spunky functional website in a matter of minutes, by just running:
71
6ef1ea41 »
2012-04-20 Greatly simplified the readme
72 ``` bash
73 mkdir my-new-website
74 cd my-new-website
75 docpad run
76 ```
1bfb7fef »
2011-03-23 More initial
77
f1bde1d9 »
2012-04-20 More readme improvements
78 This will create your website, watch for changes, and launch the DocPad server. It will ask you if you would like to base your website from an [already existing one](https://github.com/bevry/docpad/wiki/Skeletons "DocPad allows people to share their existing websites as skeletons, to help bootstrap your next website. You can discover a listing of them here.") to get started even quicker.
0003d524 »
2012-04-20 More readme improvements
79
b4c53303 »
2012-04-20 More readme improvements
80 Once done, simply go to [http://localhost:9778/](http://localhost:9778/) to view your new website :) or when your website uses a different port, go to the url that `docpad run` mentions
1bfb7fef »
2011-03-23 More initial
81
d7707813 »
2011-05-10 Cleaned
82
83
64135daf »
2012-04-20 More readme improvements
84 ## What next?
9a2dc7ee »
2011-11-07 Updated readme. Updated changelog. Updated credits.
85
64135daf »
2012-04-20 More readme improvements
86 Here are some quick links to help you get started:
9eda20ff »
2012-04-10 Readme improvements - updated for new wiki links.
87
9873bfdd »
2012-04-20 More readme improvements
88 - [Getting Started](https://github.com/bevry/docpad/wiki/Getting-Started)
9eda20ff »
2012-04-10 Readme improvements - updated for new wiki links.
89 - [Frequently Asked Questions](https://github.com/bevry/docpad/wiki/FAQ)
90 - [Showcase and Examples](https://github.com/bevry/docpad/wiki/Showcase)
91 - [Guides and Tutorials](https://github.com/bevry/docpad/wiki/Guides)
6ef1ea41 »
2012-04-20 Greatly simplified the readme
92 - [Hosting Guide](https://github.com/bevry/docpad/wiki/Hosting)
9eda20ff »
2012-04-10 Readme improvements - updated for new wiki links.
93 - [Extension Guide](https://github.com/bevry/docpad/wiki/Extending)
9781b2b7 »
2012-04-20 More readme improvements
94 - [Plugins](https://github.com/bevry/docpad/wiki/Plugins)
95 - [Skeletons](https://github.com/bevry/docpad/wiki/Skeletons)
ddef588b »
2012-04-20 More readme improvements
96 - [Troubleshooting](https://github.com/bevry/docpad/wiki/Troubleshooting)
35922fc8 »
2012-04-20 More readme improvements
97 - [Support Forum](https://groups.google.com/forum/#!forum/docpad)
98 - [Bug Tracker](https://github.com/bevry/docpad/issues)
a760a9b9 »
2012-07-09 Added API wiki page to readme, and worked around IRC chat room link n…
99 - IRC Chat Room: `#docpad` on freenode
cb6caa15 »
2012-04-10 more readme links
100 - [Everything else](https://github.com/bevry/docpad/wiki)
9a2dc7ee »
2011-11-07 Updated readme. Updated changelog. Updated credits.
101
73f8d48a »
2011-11-14 v2.2.0. Updated readme. Fixed bug with dynamic pages mime type.
102
6ef1ea41 »
2012-04-20 Greatly simplified the readme
103
06ffe719 »
2012-01-18 Added note about History.md inside readme
104 ## History
105
7b581ba4 »
2012-04-20 More readme improvements
106 You can discover the version history inside the [History.md](https://github.com/bevry/docpad/blob/master/History.md#files) file
84f88326 »
2011-10-03 readme updates
107
108
cdf1a062 »
2012-02-15 more readme updates
109
72322ed3 »
2012-07-19 special thanks after license
110 ## License
111
112 Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://creativecommons.org/licenses/MIT/)
113 <br/>Copyright &copy; 2012 [Bevry Pty Ltd](http://bevry.me)
114 <br/>Copyright &copy; 2011 [Benjamin Lupton](http://balupton.com)
115
116
117
57f415ab »
2012-07-19 Bumped version to v6.4.0. Added contributor listing to readme
118 ## Special Thanks
64135daf »
2012-04-20 More readme improvements
119
1c9b1e8c »
2012-07-19 Update special thanks
120 Special thanks to all our wonderful contributors who have helped shaped the DocPad core of today:
57f415ab »
2012-07-19 Bumped version to v6.4.0. Added contributor listing to readme
121
122 - [Benjamin Lupton](https://github.com/balupton)
123 - [eldios](https://github.com/eldios)
124 - [Changwoo Park](https://github.com/pismute)
125 - [Todd Anglin](https://github.com/toddanglin)
126 - [Olivier Bazoud](https://github.com/obazoud)
127 - [Zhao Lei](https://github.com/firede)
128 - [Aaron Powell](https://github.com/aaronpowell)
129 - [Andrew Patton](https://github.com/acusti)
130 - [Paul Armstrong](https://github.com/paularmstrong)
131 - [Sorin Ionescu](https://github.com/sorin-ionescu)
132 - [Ferrari Lee](https://github.com/Ferrari)
133 - [Ben Barber](https://github.com/barberboy)
134 - [Nick Crohn](https://github.com/ncrohn)
97e25956 »
2012-08-10 Added contributors to package.json, updated history with pull request…
135 - [Bruno Héridet](https://github.com/Delapouite)
1c9b1e8c »
2012-07-19 Update special thanks
136 - [Sven Vetsch](https://github.com/disenchant)
57f415ab »
2012-07-19 Bumped version to v6.4.0. Added contributor listing to readme
137
345134aa »
2012-07-19 read me updates
138 Also thanks to all the countless others who have continued to raise DocPad even higher by submitting plugins, issues reports, discussion topics, IRC chat messages, and praise on twitter. We love you.
57f415ab »
2012-07-19 Bumped version to v6.4.0. Added contributor listing to readme
139
345134aa »
2012-07-19 read me updates
140 Lastly, thank YOU for giving us a go, believing us, and loving us. We love you too.
141
142 Sincerely, the DocPad team
e94c9530 »
2012-04-20 More readme improvements
143
72322ed3 »
2012-07-19 special thanks after license
144 [![Flattr this project](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/344188/balupton-on-Flattr)
Something went wrong with that request. Please try again.