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

yaml-markdown-loader

v3.2.2

Published

Loader that parses markdown to html as well as document meta information defined in yaml format

Downloads

2

Readme

Build Status

Yaml and Markdown webpack loader.

Why

Sometimes you want to generate a complete html page out of your markdown file, but markdown is just not enough for an html page, you also need a bunch of meta information about your page (like title and etc.), that you want to control somehow. For that purpose you are know able to do it like this:

---
head:
  title: Test title
  meta-description: Page to get a test information
---
# Test title

 your awesome markdown content

The area between two --- is nothing else as a Yaml and everything below is your actual Markdown.

An output that will be generated is equal to a following JSON object:

{ meta:
   { head:
      { title: 'Test title',
        'meta-description': 'Page to get a test information'
      }
   },
  html: '<h1 id="test-title">Test title</h1>\n<p> your awesome markdown content</p>\n'
}

Configuration

Your webpack.config.js can look like this:

entry: __dirname + '/entry.js',
output: {
  path: __dirname,
  filename: 'bundle.js'
},
module: {
  loaders: [
    {test:/\.md$/, loader:'yaml-markdown'}
  ]
}

Code Render Extensions

Sometime you want to introduce new languages for markdown code blocks, to achive this you have to provide filename of a custom renderer in loader query

  {test: /\.md$/, loader: 'json!yaml-markdown?codeRenderer=customLangExtension'}

and implement a file in a following location: <your_project_folder>/yaml-markdown-loader-extentions/<codeRenderer>.js

The implementation of this file have to provide a function that takes 3 arguments:

  • code
  • lang
  • callback (optional)
export default  (code, lang, escaped) => {
  return <markup>you need</markup>
}

To Do

  • enable markdown custom options