Giter VIP home page Giter VIP logo

markdown-it-meta's Introduction

Markdown-it-meta

Markdown-it plugin to add YAML metadata

NPM version Build status

Install

$ npm install markdown-it-meta --save

Use

const MarkdownIt = require('markdown-it')
const meta = require('markdown-it-meta')

// Make new instance
const md = new MarkdownIt()
// Add markdown-it-meta
md.use(meta)

const renderedDocument =  md.render('<md with YAML>')
return {
  document: renderedDocument,
  meta: md.meta
}

Features

Adds YAML to markdown documents to be used as meta data.

  • Make Strings
  • Make Arrays
  • Make Objects
  • All YAML is valid

Markdown

---
title: Welcome to Markdown-it-meta
keywords: markdown-it-meta
runs: 0
score: 0.0
demographics:
 - {name: 'unknown'}
---
## Hello World

markdown-it-meta's People

Contributors

scott-wyatt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

markdown-it-meta's Issues

[Bug] Running render on markdown without meta will return meta from the previous run

Example:

const MarkdownIt = require('markdown-it')
const meta = require('markdown-it-meta')

// Make new instance
const md = new MarkdownIt()
// Add markdown-it-meta
md.use(meta)

let renderedDocument1 =  md.render('---\nfoo: true\n---\n# Foo')
let result1 = {
  document: renderedDocument1,
  meta: {...md.meta}
}

let renderedDocument2 =  md.render('# Fee')
let result2 = {
  document: renderedDocument2,
  meta: {...md.meta}
}

console.log("Result 1", result1)
console.log("Result 2", result2)
  • result1.meta will be have an expected value of {foo: true}
  • result2.meta should have a value of {} but ๐Ÿœ it does not and instead returns {foo: true}

YAML lists indented with tabs

The plugin does not parse yaml lists correctly when they are indented with tabs

---
title: A post about cats
description: Cats are very awesome, and here is why.
tags:
	- cats
	- mew
---

crashes when the list is indented with tabs

However,

---
title: A post about cats
description: Cats are very awesome, and here is why.
tags:
    - cats
    - mew
---

is indented with spaces and works as expected.

Thanks !

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.