An open API service indexing awesome lists of open source software.

https://github.com/uuanqin/markdown-it-obsidian-imgsize

A plugin to process Obsidian image sizing.
https://github.com/uuanqin/markdown-it-obsidian-imgsize

image imagesize markdown-it markdown-it-plugin obsidian

Last synced: 3 months ago
JSON representation

A plugin to process Obsidian image sizing.

Awesome Lists containing this project

README

          

# markdown-it-obsidian-imgsize

language: English | [中文](./README_zh.md)

A markdown-it plugin, adding width (and height) attributes to image elements.

According to [the syntax of external images in Obsidian](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#External+images)
, it transforms
```markdown
![A cat|100](cat.jpg)
![A cat|100x200](cat.jpg)
```
to
```html

A cat


A cat


```

More cases are in [examples.md](./test/examples.md). Different from [markdown-it-renderer-image](https://www.npmjs.com/package/@peaceroad/markdown-it-renderer-image),
this plugin does not use the Internet when processing online images.

## Install

```bash
npm i markdown-it-obsidian-imgsize --save
```

## Use

```js
const md = require('markdown-it')();
const mdImgSizePlg = require('markdown-it-obsidian-imgsize');
md.use(mdImgSizePlg);

const content = '![A cat|100](cat.jpg)';
console.log(md.render(content));
//

A cat


// See './test/examples.md' for more examples
```

## Related Plugins

[markdown-it-renderer-image](https://www.npmjs.com/package/@peaceroad/markdown-it-renderer-image)

[markdown-it-obsidian-images](https://www.npmjs.com/package/markdown-it-obsidian-images)

## License
MIT