npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

markdown-it-obsidian-images

v1.0.1

Published

Obsidian-compatible image syntax for the markdown-it parser

Downloads

40

Readme

Markdown-It Obsidian Images

Build Status Coverage Status

Renders Obsidian-style images in markdown-it. This is useful for making Obsidian-based blogs or digital gardens..

Usage

Install this into your project:

npm --save install markdown-it-obsidian-images

...and use it:

const obsidianImages = require('markdown-it-obsidian-images')(options)
const md = require('markdown-it')()
    .use(obsidianImages)
    .render('![[Image1|A beautiful image]] [[/Image2]]')

Output:

<p><img src="./Image1.png" alt="A beautiful image" /> <img src="/Image2.png" /></p>

Options

baseURL

Default: /

The base URL for absolute image URLs.

const html = require('markdown-it')()
  .use(require('markdown-it-obsidian-images')({ baseURL: '/content/' }))
  .render('![[/Hero Image]]')
  // <p><img src="/content/Hero_Image.png" /></p>

relativeBaseURL

Default: ./

The base URL for relative wiki links.

const html = require('markdown-it')()
  .use(require('markdown-it-obsidian-images')({ relativeBaseURL: '/content/', suffix: '' }))
  .render('![[Hero Image]]')
  // <p><img src="/content/Hero_Image" /></p>

makeAllLinksAbsolute

Default: false

Render all image URLs as absolute paths.

uriSuffix

Default: .png

Append this suffix to every URL.

const html = require('markdown-it')()
  .use(require('markdown-it-obsidian-images')({ uriSuffix: '.jpg' }))
  .render('![[Hero Image]]')
  // <p><img src="./Hero_Image.jpg" /></p>

htmlAttributes

Default: {}

An object containing HTML attributes to be applied to every link.

const attrs = {
  'class': 'full-width'
}
const html = require('markdown-it')()
  .use(require('markdown-it-obsidian-images')({ htmlAttributes: attrs }))
  .render('![[Hero Image]]')
  // <p><img src="./Hero_Image.png" class="full-width" /></p>

postProcessImageName

A transform applied to every page name.

The default transform does the following things:

  • trim surrounding whitespace
  • sanitize the string

Example

const _ = require('slugify')

function myCustomPostProcessImageName(label) {
  return label.split('/').map(function(pathSegment) {
    return slugify(pathSegment.toLowerCase())
  })
}

const html = require('markdown-it')()
  .use(require('markdown-it-obsidian-images')({ postProcessImageName: myCustomPostProcessImageName }))
  .render('![[Hello World]]')
  // <p><img src="./hello-world.png" /></p>

postProcessLabel

A transform applied to every image alt label. You can override it just like postProcessImageName (see above).

The default transform trims surrounding whitespace and replaces the characters <&" with html-encoded equivalents

Credits

Based on markdown-it-wikilinks by Julio Sepia