html-comments

v0.5.0

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

2/weekUpdated 3 years ago

Published by Arjen Scherff-de Water

npm install html-comments

Repository Homepage npm

html-comments

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

Example

js
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>

', options);
var comments = htmlcomments.loadFile('file.html', options);

htmlcomments.loadURL('http://www.example.com/index.html', options, function(err, comments) {});`

`html

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.