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

@igor.dvlpr/strip-yaml-front-matter

v1.0.0

Published

🦓 Strips YAML front matter from a String or a file. 👾

Downloads

85

Readme

🤔 Introduction

YAML front matter is a special text/code block placed between two triple-dashed lines that is added to the top of a file, usually Markdown (.md), sometimes even HTML (.html) files and provides meta data about the given file or provide means to do additional processing of the file. It is mostly used by static site generators (SSG) or content management systems (CMS).

Here's an example Markdown file:

example.md

---
 author: John Doe
 publishDate: 27 Aug, 2024
---

Some Markdown content.

🕵🏼 Usage

Install it by executing:

npm i "@igor.dvlpr/strip-yaml-front-matter"

🤹🏼 API

function stripString(content: string): string

Strips YAML front matter from a String.

  • content: string, the string whose YAML front matter to strip.

Returns the original String without the YAML front matter.

function stripFile(path: string): string

Strips YAML front matter from a file.

  • path: string, the path to the file.

[!WARNING] Will throw an error if the file path is not valid or the file cannot be read.

Returns the original file contents as a String without the YAML front matter.


🪪 License

Licensed under the MIT license which is available here, MIT license.


🧬 Related

@igor.dvlpr/is-rootdir

🔼 Provides a way to check if the given path is the root drive/directory. ⛔

@igor.dvlpr/recursive-readdir

📖 Provides recursive readdir() and readdirSync() functions. 📁

@igor.dvlpr/extendable-string

🦀 ExtendableString allows you to create strings on steroids that have custom transformations applied to them, unlike common, plain strings. 🪀

@igor.dvlpr/regkeys

📚 An npm package for fetching Windows registry keys. 🗝

@igor.dvlpr/zep

🧠 Zep is a zero-dependency, efficient debounce module. ⏰

Provided by Igor Dimitrijević (@igorskyflyer).