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

vite-remark-html

v1.1.1

Published

Process markdown with remark-html

Downloads

48,595

Readme

vite-remark-html

npm Code style: Prettier Donate

Process markdown with remark-html

Basically, when you import a .md file, you'll get back a JS module with an HTML string as its default export. There are various options to customize the HTML output.

 

Usage

import remarkHtml from 'vite-remark-html'

export default {
  plugins: [remarkHtml()],
}

Remark plugins

To add Remark plugins, call the use method on the Vite plugin. It returns the Vite plugin, so you can easily chain together multiple .use calls.

import remarkHtml from 'vite-remark-html'
import remarkSlug from 'remark-slug'

export default {
  plugins: [remarkHtml().use(remarkSlug)],
}

Filter options

Markdown files can be filtered, in case you only want a subset to be processed by this plugin.

remarkHtml({
  exclude: /\/node_modules\//,
})

For more details, see here.

HTML options

All options listed here are also supported.

remarkHtml({
  allowDangerousHtml: true,
})

Using the HTML

In your client code, you can use import or dynamic import() to load the HTML string.

import html from './test.md'
// or
const htmlPromise = import('./test.md').then(module => module.default)

Then you can use that as the innerHTML of another element.

document.getElementById('markdown').innerHTML = html
// or
<div dangerouslySetInnerHtml={{ __html: html }} />

Try the demo to see it in action.

TypeScript usage

In your tsconfig.json

{
  "compilerOptions": {
    "types": ["vite-remark-html/client"]
  }
}

This lets you import .md files with type-checking support.