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

metalsmith-markdown-partials

v2.3.0

Published

A Metalsmith plugin that allows the use of partial markdowm files

Downloads

47

Readme

metalsmith-markdown-partials

A Metalsmith plugin that enables the use of Markdown partials.

metalsmith: plugin npm: version license: ISC

Markdown fragments are inserted into the contents of a page markdown file by replacing an include marker with markdown partials. This allows for modular markdown and promotes reuse of content.

Installation

$ npm install --save metalsmith-markdown-partials

Usage

var mdPartials = require('metalsmith-markdown-partials');

...
.use(mdPartials({
    libraryPath: './markdown-partials/',
    fileSuffix: '.md.njk',
  }))
...

Options

libraryPath

The default libraryPath is ./markdown-partials/. This default assumes that all pages are located in ./src/ so the markdown partials are located inside the metalsmith source directory.

const mdPartials = require('metalsmith-markdown-partials');

metalsmith(__dirname)
  .use(mdPartials({
    libraryPath: './markdown-partials/'
  })

fileSuffix

The default fileSuffix is .md, but depending on which templating language is used, the suffix will have two parts. For example for Nunjucks it will be md.njk.

const mdPartials = require('metalsmith-markdown-partials').use(
  mdPartials({
    fileSuffix: '.md.njk'
  })
);

How it works

Include marker

{#md "<file name>.md" #}

Page Markdown File

A markdown file that will be transformed into an html file via a template

Markdown Partial

A markdown file to be inserted into a Page Markdown file

Markdown partials are located in a separate directory, for example /markdown-library/. This directory should be located inside /src/ .

Partial markdown files have the extention .md. A markdown partial file does NOT have frontmatter metadata, only the markdown to be inserted into a page markdown file.

The markdown partials directory's default location is ./src/markdown-library/. The partials directory can be set via the libraryPath option.

Example

index.md

# This is an Example Page

Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec id elit non mi porta gravida at eget metus. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.

{#md "example_partial.md" #}

Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.

example_partial.md

## Inserted Content

Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Nulla vitae elit libero, a pharetra augue.

index.html

<h1>This is an Example Page</h1>

<p>
  Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec id elit non mi porta
  gravida at eget metus. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec
  elit.
</p>

<h2>Inserted Content</h2>
<p>Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Nulla vitae elit libero, a pharetra augue.</p>

<p>
  Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam.
  Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Cum sociis natoque penatibus et magnis dis
  parturient montes, nascetur ridiculus mus.
</p>

Debug

To enable debug logs, set the DEBUG environment variable to metalsmith-markdown-partials:

Linux/Mac:

DEBUG=metalsmith-markdown-partials

Windows:

set "DEBUG=metalsmith-markdown-partials"

CLI usage

To use this plugin with the Metalsmith CLI, add metalsmith-markdown-partials to the plugins key in your metalsmith.json file:

{
  "plugins": [
    {
      "metalsmith-markdown-partials": {
        "libraryPath": "./markdown-partials/",
        "fileSuffix": ".md.njk"
      }
    }
  ]
}

Author

License

Code released under the ISC license.