From bc221f42cf97f763974762745255b46614a321d7 Mon Sep 17 00:00:00 2001 From: Tatsuya Yatagawa <tatsy.mail@gmail.com> Date: Mon, 2 Feb 2015 16:31:17 +0900 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index c184044..4850d2d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,31 @@ # markdown-it-imsize [](https://travis-ci.org/tatsy/markdown-it-imsize) +[](https://www.npmjs.org/package/markdown-it-imsize) [](https://coveralls.io/r/tatsy/markdown-it-imsize) > markdown-it plugin for size-specified image markups. + +## Usage + +#### Enable plugin + +```js +var md = require('markdown-it')({ + html: true, + linkify: true, + typography: true +}).use(require('markdown-it-imsize'); // <-- this use(package_name) is required +``` + +#### Example + +```md + +``` + +is interpreted as + +```html +<p><img src="image.png" width="100" height="200"></p> +``` -- GitLab