Code Monkey home page Code Monkey logo

metamarkdown's Introduction

Metamarkdown

This package exposes a function which lets you add metadata to your markdown file.

Format your markdown file with 3 dashes, your meta data formatted as json, 3 more dashes, then the body of your file.

---
{
  "title": "My Blog Post",
  "date": "January 15, 2017",
  "tags": ["javascript", "web development", "markdown"],
  "author": "Wyatt Sweet"
}
---

# My Blog Post

Here is the body of my post

In Node, you can read this file from the filesystem and pass it to the function like so

const markdownMetaData = require('metamarkdown');

fs.readFile(
  path.join(__dirname, 'file.md'),
  { encoding: 'utf8' },
  (err, data) => {
    const parsedMD = markdownMetaData(data);
  }
);

In the above example parsedMD will equal an object with 2 properties metaData and body.

// parsedMD

{
  metaData: {
    title: "My Blog Post",
    date: "January 15, 2017",
    tags: ["javascript", "web development", "markdown"],
    author: "Wyatt Sweet"
  },
  body: "#My Blog Post\nHere is the body of my post"
}

metamarkdown's People

Contributors

wyattsweet avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.