{"action":"created","issue":{"url":"https://api.github.com/repos/denysdovhan/gulp-remark/issues/1","labels_url":"https://api.github.com/repos/denysdovhan/gulp-remark/issues/1/labels{/name}","comments_url":"https://api.github.com/repos/denysdovhan/gulp-remark/issues/1/comments","events_url":"https://api.github.com/repos/denysdovhan/gulp-remark/issues/1/events","html_url":"https://github.com/denysdovhan/gulp-remark/pull/1","id":120629654,"number":1,"title":"0.1.0","user":{"login":"denysdovhan","id":3459374,"avatar_url":"https://avatars.githubusercontent.com/u/3459374?v=3","gravatar_id":"","url":"https://api.github.com/users/denysdovhan","html_url":"https://github.com/denysdovhan","followers_url":"https://api.github.com/users/denysdovhan/followers","following_url":"https://api.github.com/users/denysdovhan/following{/other_user}","gists_url":"https://api.github.com/users/denysdovhan/gists{/gist_id}","starred_url":"https://api.github.com/users/denysdovhan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/denysdovhan/subscriptions","organizations_url":"https://api.github.com/users/denysdovhan/orgs","repos_url":"https://api.github.com/users/denysdovhan/repos","events_url":"https://api.github.com/users/denysdovhan/events{/privacy}","received_events_url":"https://api.github.com/users/denysdovhan/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":30,"created_at":"2015-12-06T11:54:02Z","updated_at":"2016-01-05T21:49:20Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/denysdovhan/gulp-remark/pulls/1","html_url":"https://github.com/denysdovhan/gulp-remark/pull/1","diff_url":"https://github.com/denysdovhan/gulp-remark/pull/1.diff","patch_url":"https://github.com/denysdovhan/gulp-remark/pull/1.patch"},"body":"## Usage\r\n\r\n```js\r\nimport gulp from 'gulp';\r\nimport remark from 'gulp-remark';\r\nimport html from 'remark-html';\r\n\r\ngulp.task('default', () =>\r\n  gulp.src('*.md')\r\n    .pipe(remark.use(html))\r\n    .pipe(gulp.dest('dist'))\r\n);\r\n```\r\n\r\n## API\r\n\r\n### gulpRemark([options])\r\n\r\n#### options\r\n\r\nType: `Object`  \r\nDefault: `{}`\r\n\r\nSee the [`remark.process`][mdast-opts] options.\r\n\r\n### gulpRemark.use([plugin][remark-plugins][, options])\r\n\r\nChange the way [`remark`][mdast] works by using a [`plugin`][mdast-plugins].\r\n\r\n#### plugin\r\n\r\n*Required*  \r\nType: `Function|Array.<Function>`\r\n\r\nA [remark plugin][mdast-plugins] or `Array` of plugins.\r\n\r\n#### options\r\n\r\nType: `Object`  \r\nDefault: `{}`\r\n\r\nPassed to plugin. Specified by its documentation.\r\n\r\n[mdast]: http://mdast.js.org/\r\n[mdast-opts]: https://github.com/wooorm/mdast/blob/master/doc/mdastsetting.7.md\r\n[mdast-use]: https://github.com/wooorm/mdast#mdastuseplugin-options\r\n[mdast-plugins]: https://github.com/wooorm/mdast/blob/master/doc/plugins.md"},"comment":{"url":"https://api.github.com/repos/denysdovhan/gulp-remark/issues/comments/169144080","html_url":"https://github.com/denysdovhan/gulp-remark/pull/1#issuecomment-169144080","issue_url":"https://api.github.com/repos/denysdovhan/gulp-remark/issues/1","id":169144080,"user":{"login":"denysdovhan","id":3459374,"avatar_url":"https://avatars.githubusercontent.com/u/3459374?v=3","gravatar_id":"","url":"https://api.github.com/users/denysdovhan","html_url":"https://github.com/denysdovhan","followers_url":"https://api.github.com/users/denysdovhan/followers","following_url":"https://api.github.com/users/denysdovhan/following{/other_user}","gists_url":"https://api.github.com/users/denysdovhan/gists{/gist_id}","starred_url":"https://api.github.com/users/denysdovhan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/denysdovhan/subscriptions","organizations_url":"https://api.github.com/users/denysdovhan/orgs","repos_url":"https://api.github.com/users/denysdovhan/repos","events_url":"https://api.github.com/users/denysdovhan/events{/privacy}","received_events_url":"https://api.github.com/users/denysdovhan/received_events","type":"User","site_admin":false},"created_at":"2016-01-05T21:49:20Z","updated_at":"2016-01-05T21:49:20Z","body":"@wooorm You have an mistake in commit message:\r\n\r\n```js\r\nvar CLI = require('remark/lib/cli/cli');\r\nvar engine = require('remark/lib/cli');\r\nvar html = require('remark-html');\r\n\r\nvar cli = new CLI({\r\n    'files': 'readme.md'\r\n}).use(html);\r\n\r\nrun(cli, function (err, success) {\r\n    console.log('done!', err, 'successfully?', success);\r\n});\r\n```\r\n\r\nYou required `engine`, but use `run()` which isn't required. By the way, [`remark/lib/cli`](https://github.com/wooorm/remark/blob/4e65d7086041240047991c3f459e21811983978a/lib/cli/index.js#L131) doesn't export `run()` function. Or maybe I'm wrong?\r\n\r\nThis makes me confused, so I still don't understand how may I use it."}}