template-todos

    0.1.0 • Public • Published

    template-todos NPM version

    Middlware for Template, for matching todos in a string.

    Install

    Install with npm

    $ npm i template-todos --save

    Usage

    var todos = require('template-todos');
     
    // register as an `onLoad` middleware
    template.onLoad(/./, todos(template));
     
    // example pages with `todos` 
    template.page('foo', {content: '// todo: foo bar baz'});
    template.page('bar', {content: '/*\n * todo: a b c \n */\n// todo: x y z'});
    template.page('baz', {content: '<!-- todo: one two three -->'});

    Adds an array of todos for each template to the todos object on the context:

    var todos = template.cache.data.todos;
    //=> results in:
    // {
    //   foo: [ 'foo bar baz' ],
    //   bar: [ 'a b c', 'x y z' ],
    //   baz: [ 'one two three' ]
    // }

    Related projects

    • assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more
    • todo-regex: Regular expression for matching TODO statements in a string.
    • template-toc: Middleware for generating a markdown Table of Contents with Template or applications based on Template.
    • template: Render templates using any engine. Supports, layouts, pages, partials and custom template types. Use template… more
    • verb: Documentation generator for GitHub projects. Extremely powerful, easy to use, can generate anything from API… more

    Running tests

    Install dev dependencies:

    $ npm i -d && npm test

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

    Author

    Jon Schlinkert

    License


    This file was generated by verb-cli on May 26, 2015.

    Install

    npm i template-todos

    DownloadsWeekly Downloads

    2

    Version

    0.1.0

    License

    MIT

    Last publish

    Collaborators

    • doowb
    • jonschlinkert