Nascent Personality Manifestation
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    html-commentspublic

    html-comments

    Simple nodejs module that collects all comments from input HTML. Optionally filter out everything that starts with a given keyword.

    Example

    var htmlcomments = require('html-comments');
     
    var options = {
      keyword: 'yep', // keyword to filter comments with 
      removeKeyword: true // returns just the comment body without the keyword 
    };
     
    var comments = htmlcomments.load('div></div>', options);
     
    var comments = htmlcomments.loadFile('file.html', options);
     
    htmlcomments.loadURL('http://www.example.com/index.html', options, function(err, comments) {});
    <div>
      <!-- yep
      ima be collected
      -->
     
      <!-- nope
      aint gonna be collected
      -->
     
      <!--
      me either
      -->
    </div>

    API

    loadFile(path, options)

    Load an html file at the given path. Returns all comments from that html file.

    loadURL(url, options, cb)

    Load an html page at the given url. Returns all comments from that html page.

    load(src, options)

    Load html source string. Returns all comments.

    Keywords

    none

    install

    npm i html-comments

    Downloadsweekly downloads

    22

    version

    0.5.0

    license

    none

    repository

    github.com

    last publish

    collaborators

    • avatar