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

remarkable-front-matter

v1.0.1-beta.1

Published

YAML front matter block support for Remarkable

Downloads

2,649

Readme

remarkable-front-matter

Make Remarkable Extensible Markdown Parser process the file with a YAML front matter block ahead of a markdown file. This design is inspired by Jekyll's Front Matter.

Here is a basic example:

---
title: ManDoc: Leverage your Reusable Knowledge posted in Markdown.
author:  Richard Lea
---

The front matter must take the form of valid YAML set between triple-dashed lines. Between these triple-dashed lines, you can set predefined variables or even create custom ones of your own.

These variables will then be available to template package to access and render in any layouts or create some interesting rendering logic for that page or post , for example in question relies on.

Installation

$ npm install remarkable-front-matter

Quick Start

Given a sample markdown string started by a YAML meta data surrounded by triple-dashed lines, ---, to render, the YAML front-matter could be availabe through remarkable render env, the key-value store created by parsing rules:

import frontMatterPlugin from 'remarkable-front-matter';

// Init Remarkable Renderer Instance with frontMatterPlugin loading.
const md = new Remarkable();
md.use(frontMatterPlugin);

// Prepare an environment mapping object for keeping frontMatter Data later.
const env = {frontMatter: undefined};
md.render([
    '---',
    'title: Remarkable-Front-Matter README',
    'date: 2018-12-10 15:15:19',
    '---',
].join('\n'), env);

console.log(env);
/**
 * Will Output:
 * { title: 'Remarkable-Front-Matter README', date: 2018-12-10T15:15:19.000Z }
 /

All the examples above are written in TypeScript, which means that JavaScript usage is surely without problem.

However, I found that the design of Remarkable itself is actually not friendly for TypeScript Users to develop plugins, as well.