• Stars
    star
    3,052
  • Rank 14,138 (Top 0.3 %)
  • Language
    CoffeeScript
  • License
    Other
  • Created about 13 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Empower your website frontends with layouts, meta-data, pre-processors (markdown, jade, coffeescript, etc.), partials, skeletons, file watching, querying, and an amazing plugin system. DocPad will streamline your web development process allowing you to craft powerful static sites quicker than ever before.

DocPad. Streamlined web development.

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

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 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 redundant stuff up to me, so you can focus on the awesome stuff.

Discover my features below, or skip ahead to the installation instructions to get started with a fully functional pre-made website in a few minutes from reading this.

Watch the Screencast!

Features

Out of the box

  • Completely file based, meaning there are 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 used to (You can still hook in remote data sources if you want, DocPad doesn't impose any limits on you, ever)
  • Choose from plenty of community maintained pre-made websites to use for your next project instead of starting from scratch every time
  • 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)
  • Changes to your website are automatically recompiled through our built-in watch system
  • Add metadata 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
  • Display custom listings of content with our powerful Query Engine available to your templating engines
  • Abstract out generic headers and footers into layouts using our nested layout system
  • 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 to take advantage of custom routing with express.js. Deploy guide here
  • 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
  • Robust architecture and powerful plugin system means that you are never boxed in. Unlike traditional CMS systems, you can always extend DocPad 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
  • 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 req and res objects to your templating engine)
  • You can use it standalone, or even easily include it within your existing systems with our API

With our amazing community maintained plugins

  • Use the Live Reload plugin to automatically refresh your web browser whenever a change is made, this is amazing
  • 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
  • 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
  • Use the Partials Plugin to abstract common pieces of code into their own individual file that can be included as much as you want
  • Syntax highlight code blocks automatically with either our Highlight.js Plugin or Pygments Plugin
  • Get SEO friendly clean URLs with our Clean URLs Plugin (dynamic deployments only)
  • Lint your code automatically with our Ling Plugins: jshint and coffeelint
  • Concatenate and minify your JavaScript and CSS assets making page loads faster for your users with our Minify Plugins: htmlmin and grunt
  • Install common javascript libraries like jQuery, Backbone and Underscore directly from the command line - (under construction, coming soon)
  • Automatically translate your entire website into other languages with our Translation Plugin - under construction, coming soon
  • Add an 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 Plugins
  • Pretty much if DocPad doesn't already do something, it is trivial to write a plugin to do it. DocPad can accomplish anything; it never holds you back, and there are no limits.
  • Many other plugins not listed here that are still definitely worth checking out! :)

People love DocPad

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 of what people are saying about DocPad :)

Some favourite tweets about DocPad

Install

Click here for our latest Install Instructions.

Quick Start

Click here to skip ahead to our latest Quick Start Guide.

What next?

Here are some quick links to help you get started:

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

These amazing people have contributed finances to this project:

Become a sponsor!

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Participants

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.

License

Unless stated otherwise all works are:

and licensed under:

More Repositories

1

docpad-skeleton-bootstrap

Twitter Bootstrap skeleton for DocPad. Simple and flexible HTML, CSS, and Javascript for popular user interface components and interactions.
46
star
2

docpad-plugin-ghpages

Deploy your DocPad Website to GitHub Pages
JavaScript
44
star
3

docpad-skeleton-bootstrap-jade

Twitter Bootstrap skeleton for DocPad developed using Jade (a HAML alternative for Node.js)
30
star
4

docpad-plugin-partials

Adds support for Partials (re-usable templates) to DocPad.
JavaScript
29
star
5

docpad-plugin-paged

Adds support to DocPad for rendering a document into multiple pages.
HTML
28
star
6

docpad-skeleton-h5bp

HTML5 Boilerplate skeleton for DocPad. Bare essentials for building a modern website with best practices.
22
star
7

docpad-plugin-cleanurls

Adds support for clean urls to DocPad
JavaScript
21
star
8

docpad-plugin-highlightjs

Adds support for Highlight.js syntax highlighting to DocPad
JavaScript
20
star
9

docpad-plugin-services

Adds super simple support for many 3rd party services to DocPad.
CoffeeScript
18
star
10

docpad-plugin-thumbnails

DocPad plugin that manages thumbnail generation of your image files
JavaScript
18
star
11

docpad-plugin-feedr

Adds support for reading feeds to DocPad
HTML
18
star
12

docpad-plugin-stylus

Adds support for the Stylus CSS pre-processor to DocPad
CoffeeScript
14
star
13

docpad-plugin-sass

Adds support for the SASS and SCSS CSS pre-processors to DocPad. It also supports the Compass framework.
CoffeeScript
13
star
14

docpad-plugin-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
JavaScript
13
star
15

docpad-plugin-marked

Markdown rendering for DocPad, using Marked
CoffeeScript
11
star
16

docpad-plugin-livereload

Automatically refreshes your website whenever a rengeration is performed
CoffeeScript
11
star
17

docpad-plugin-related

Adds support for related documents to DocPad
CoffeeScript
10
star
18

docpad-plugin-sitemap

Auto-generated sitemaps for DocPad
CoffeeScript
10
star
19

docpad-plugin-multiplelayouts

Multiple layouts per document for DocPad
CoffeeScript
10
star
20

docpad-plugin-eco

Adds support for the Eco templating engine to DocPad.
JavaScript
10
star
21

docpad-plugin-tags

Generate tag pages with DocPad
CoffeeScript
9
star
22

dockerfile

Docker container for DocPad
Shell
8
star
23

docpad-plugin-nodesass

Adds support for the SCSS CSS pre-processor to DocPad, using node-sass
JavaScript
8
star
24

docpad-plugin-handlebars

Adds support for the Handlebars templating engine to DocPad.
CoffeeScript
7
star
25

docpad-plugin-consolidate

Template Engine Consolidation for DocPad
HTML
7
star
26

docpad-plugin-associatedfiles

DocPad plugin that fetches any associated files for our particular document
JavaScript
7
star
27

docpad-plugin-text

Allows you to render templateData with HTML elements
JavaScript
7
star
28

docpad-plugin-yourpluginname

Sample plugin structure for bootstrapping your next DocPad plugin :)
CoffeeScript
6
star
29

docpad-plugin-less

Adds support for the LESS CSS pre-processor to DocPad
JavaScript
6
star
30

docpad-plugin-repocloner

Clone git repos into your repository somewhere before each complete regeneration
CoffeeScript
5
star
31

docpad-skeleton-casper

A port of the default ghost platform theme, Casper, for use with docpad
CSS
4
star
32

docpad-plugin-serve

DocPad plugin that serves your generated DocPad website over localhost
JavaScript
4
star
33

docpad-plugin-dateurls

DocPad plugin that adds support for date based URLs to DocPad
JavaScript
4
star
34

docpad-skeleton-sass-on-heroku

Testing SASS on Heroku
ApacheConf
4
star
35

docpad-plugin-uglify

Minify JavaScript files with the uglify: true meta data
JavaScript
4
star
36

docpad-plugin-coffeescript

Adds support for CoffeeScript to JavaScript compilation to DocPad
CoffeeScript
4
star
37

docpad-plugin-coffeekup

Adds support for CoffeeKup compilation to DocPad
CoffeeScript
4
star
38

docpad-plugin-cachr

Caches remote resources locally
CoffeeScript
3
star
39

docpad-plugin-haml

Adds support for the HAML templating engine to DocPad.
CoffeeScript
3
star
40

docpad-plugin-gist

Adds support for reading gist to DocPad
HTML
3
star
41

docpad-plugin-browserifydocs

Browserify your documents by adding the `browserify: true` meta data
JavaScript
3
star
42

docpad-plugin-livescript

Adds support for LiveScript to JavaScript compilation to DocPad
CoffeeScript
3
star
43

docpad-plugin-assets

DocPad plugin to provide assets with content-based unique names
CoffeeScript
3
star
44

docpad-plugin-cson

Adds support for CSON to JSON compilation to DocPad
CoffeeScript
2
star
45

docpad-plugin-move

Adds support for the Move to javascript language to DocPad.
JavaScript
2
star
46

docpad-skeleton-beginner

Result website from DocPad's Beginner Guide
CoffeeScript
2
star
47

docpad-plugin-styl

Adds support for the Styl Rework CSS pre-processor to DocPad
CoffeeScript
2
star
48

docpad-plugin-hogan

Adds support for the Hogan templating engine to DocPad.
CoffeeScript
2
star
49

docpad-plugin-raw

Copies all files in the `/raw` directory to `/out` without going through DocPad's generation process. Useful for files that cause out of memory/speed issues when placed in /files directory.
CoffeeScript
2
star
50

docpad-plugin-downloader

Download (and optionally extract) files into your project before your project starts generating
JavaScript
2
star
51

docpad-plugin-autoprefix

Auto vendor/browser prefix CSS so you don't have to!
JavaScript
1
star
52

docpad-plugin-cleancss

Concatinate and minify CSS files with the `cleancss: true` meta data
CoffeeScript
1
star
53

docpad-plugin-pug

Adds support for the Pug templating engine to DocPad.
CoffeeScript
1
star
54

docpad-plugintester

DocPad's PluginTester class
JavaScript
1
star
55

docpad-plugin-jshint

JSHint Plugin for DocPad - seeking new maintainer
CoffeeScript
1
star
56

docpad-skeleton-benchmark

Benchmarking skeleton for DocPad
CoffeeScript
1
star
57

docpad-plugin-babel

babel plugin for docpad
JavaScript
1
star