https://github.com/yerkopalma/markdownify

https://github.com/yerkopalma/markdownify

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/yerkopalma/markdownify
• Owner: YerkoPalma
• License: other
• Created: 2018-06-25T22:22:06.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-06-26T15:44:32.000Z (almost 7 years ago)
• Last Synced: 2025-02-25T23:15:53.353Z (3 months ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# markdownify

[![Build Status](https://img.shields.io/travis/YerkoPalma/markdownify/master.svg?style=flat-square)](https://travis-ci.org/YerkoPalma/markdownify) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)

> convert markdown source to html string with metadata support

## Usage

```bash

$ browserify index.js -t markdownify > bundle.js

# if you want to use plugins

$ browserify index.js -t [ markdownify --plugins=markdown-it-emoji ] > bundle.js

```

Now every require call to a file with extension `md|markdown` will resolve in an 

object

```js

console.log(require('./readme.md'))

// {

//  document: ,

//  meta: 

// }

```

## Install

```bash

$ npm install --save-dev @yerkopalma/markdownify

```

## License

[MIT](/license)

[markdown-it]: https://github.com/markdown-it/markdown-it