Metalsmith vs DocPad
When comparing Metalsmith vs DocPad, the Slant community recommends DocPad for most people. In the question“What are the best static site generators?” DocPad is ranked 6th while Metalsmith is ranked 13th. The most important reason people chose DocPad is:
DocPad is published as an NPM module which makes it easy to integrate with an existing Node.js deployment.
Specs
Ranked in these QuestionsQuestion Ranking
Pros
Pro Flexible beyond a static site generator
Because metalsmith is at its core focused on transforming directories of files, it can be used for more than just static site generation, and could be used as a build tool, a documentation generator, or any use that requires file transformations.
Pro Designed around plugins
Everything in metalsmith is a plugin, and it is designed to make it easy to write new ones.
Pro Chaining API
Metalsmith uses a chaining API that's consistent and simple to use:
Metalsmith(__dirname)
.use(markdown)
.use(templates('handlebars'))
.build();
Pro Built on Node
DocPad is published as an NPM module which makes it easy to integrate with an existing Node.js deployment.
Pro Has an active plug-in ecosystem
DocPad's has a large amount of plug-ins available to extend its functionality and compatibility with other language preprocessors and markup languages.
- Javascript preprocessors include: Coffescript, TypeScript, and LiveScript.
- CSS preprocessors include: LESS, SASS, Stylus, and Roole
- HTML markups include: Markdown, and Textile
- Templating engines include: Eco, Handlebars, Moustache, HAML, CoffeeKup, Jade, and Teacup
- JSON converters include: YAML and CSON
Pro Has Live Reload
DocPad has a Live Reload plug-in that leverages websockets to automatically update the blog content for users live on the site.
Pro Built on top of the Express framework
Although DocPad is a static site generator, if you find the need to, you can extend the site with the Express framework for dynamic content as well.
Pro Has graphical admin interfaces for managing your blog
There are multiple custom interfaces, including miniCMS available to DocPad which provide WYSIWYG editing and article management.
Pro Easy to deploy
Deployment plug-ins make deploying to hosting providers even easier, with plug-ins for GitHub Pages, AWS, and Google Storage.
Pro MIT-licensed
Pro Prebuilt Skeletons
Skeletons are boilerplate setups to provide a baseline structure for you to fill content into.
Pro Document and file querying with Query Engine
DocPad leverages Query Engine to provide a query API for querying files.
Cons
Con Small community
The Metalsmith community is still fairly small compared to the more popular options. This results in a lack of learning resources and difficulty finding support from experienced users. However, a slack group has recently been started.
Con Not client enabled API chaining
According to the spec on API chaining, the API request/response need to associate an API object to an corresponding controller/action/uri to be able to validate and handle the request/response and the datasets.
Without that, the consuming client service cannot properly validate or relate the datasets from one to the other. Links have no relational value and the api object creates the relationship between the datasets while maintaining an api/dataset relationship with the corresponding controller/action/uri
As such, the current methodology supported would not be able to be called by the client not supported by the client in a RESTFUL manner
Con Support for Handlebars templates is not mature - integration is awkward
Handlebars' philosophy of "no logic in templates" makes some things difficult:
- DocPad built-in template helpers aren't available by default - they have to be manually added/exposed
- DocPad's example template code often includes logic, which makes it impossible to use within Handlebars templates -- it has to be abstracted into custom helper functions.
- Can't pass objects to function calls from within HB templates.
Con More up-front investment to learn/use well
DocPad provides a LOT of extensibility and dynamic capability, which means there's more up-front investment to learn DocPad well -- and deviating from the defaults while maintaining project robustness may be difficult.