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

mini-md

v2.1.1

Published

An express view engine that serves as a templating engine for markdown files

Downloads

5

Readme

mini-md

A view engine / template engine for express that can serve your markdown files as HTML.

Installation

yarn add mini-md

Syntax

Templates

You can reference other markdown files in your markdown files by using the following syntax:

[](md:path/to/file.md)

You can also use template bindings in your markdown files by using the following syntax:

[](md:path/to/file.md, key=value, key2=value2)

The key=value pairs are passed to the template engine and can be used in the referenced file:

Key has value: {key}
Key2 has value: {key2}

Note that this means you need to escape opening curly braces in your markdown files:

This is an opening curly: {curly-open}

You can also provide a bindings object to the render function:

app.get("/", (req, res) => {
  res.render("index.md", { bindings: { key: "value", key2: "value2" } });
});

Modifying the document

You can add <head> tags straight to your markdown if you supply html: true into mdOptions:

app.engine("md", miniMd({ mdOptions: { html: true } }));

You can also add attributes to your body and html tags by adding the respective tags in your markdown files with the attributes you want:

<html lang="en" />
<body class="body" />

Usage

In your typescript:

import express from "express";
import path from "path";
import { miniMd } from "mini-md";

const app = express();
app.engine("md", miniMd());
app.set("views", "views");

app.get("/", (req, res) => {
  res.render("index.md");
});

In ./md/fragments/header.md:

# So long

In ./md/index.md:

[](md:fragments/header.md)

and thanks for all the fish!

Or even something like this:

header:

# So long {msg}

index:

[](md:fragments/header.md, msg=and thanks for all the fish!)

See the examples if you want to see it in action.

Todos

  • [ ] Test more extensively
  • [ ] Simplify the code
  • [ ] Make a prettier plugin for the md syntax + html