UNPKG

verb

Version:

Verb makes it easy to build project documentation using simple markdown templates, with zero configuration required.

27 lines (20 loc) 1.37 kB
## How does Verb differ from Assemble? Verb was specifically created to make it easier to manage documentation for GitHub projects. In a nutshell: * Use [Assemble][] to build components, sites, blogs and other projects where HTML is the end result. * Use Verb to generate and maintain markdown documentation for your [Assemble][] (or non-Assemble) projects. ### Comparison While both engines can be extended to accomplish most of the following features, this table describes what you should expect from each _out-of-the-box_: **Feature** | **[Assemble][]** | **Verb** ------- | -------- | ------ **Summary** | Build HTML projects from modular components and data | Generate markdown documentation **Focus** | Power, granular access to context, components | Speed, ease-of-use, command-line **Template Engine** | Handlebars by default, any template engine can be added. | Lo-Dash **Extensions** | Plugins, Lo-Dash Mixins, Helpers, Filters, Tags <sup>[1](#1-depends-on-the-template-engine)</sup> | Plugins, Lo-Dash Mixins, Filters, Tags **Static Blogs** | Yes | No **Static Sites** | Yes | No **HTML Documentation** | Yes | Limited. **Markdown Documentation** | Limited | Yes **Markdown to HTML** | Yes | Limited ##### <sup>1</sup> Depends on the template engine. [Assemble]: https://github.com/assemble/assemble [gray-matter]: https://github.com/assemble/gray-matter