# flavored-markdown

> Command line tool that output HTML from a github flavored markdown file

Latest version **0.1.15** (published 2021-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install flavored-markdown
pnpm add flavored-markdown
yarn add flavored-markdown
bun add flavored-markdown
```

Provides the command `flavored-markdown`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.15 |
| Published | 2021-09-03 |
| First published | 2015-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jorge Solis Pauwels |
| Maintainers | solispauwels |

## Links

- npm: https://www.npmjs.com/package/flavored-markdown
- npm.io page: https://npm.io/package/flavored-markdown

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^3.0.0

## Recent versions

- 0.1.15 (latest) — 2021-09-03
- 0.1.14 — 2021-09-03
- 0.1.13 — 2021-09-03
- 0.1.12 — 2015-03-16
- 0.1.11 — 2015-03-16
- 0.1.10 — 2015-02-03
- 0.1.9 — 2015-02-03
- 0.1.8 — 2015-02-03
- 0.1.7 — 2015-02-03
- 0.1.6 — 2015-01-27
- 0.1.5 — 2015-01-26
- 0.1.4 — 2015-01-26
- 0.1.3 — 2015-01-26
- 0.1.2 — 2015-01-26
- 0.1.1 — 2015-01-26
- … 1 more at https://npm.io/package/flavored-markdown/versions

## README

Flavored markdown
=================

Command line tool that output HTML from a github flavored markdown file.

 - [Installation](#installation)
 - [Global usage](#global-usage)
 - [Library usage](#library-usage)
 - [Contribute](#contribute)
 - [How to use with VIM](#how-to-use-with-vim)

Installation:
-------------

```sh
npm install -g flavored-markdown
```

Or

```sh
npm install flavored-markdown
```

Global Usage:
-------------

```sh
flavored-markdown < markdown.md > markdown.html
```

Or for better file escaping text

```sh
flavored-markdown "$(< markdown.md)" > markdown.html
```

Or

```sh
flavored-markdown "Some *markdown*" > markdown.html
```

Library usage:
--------------

```javascript
import Markdown from 'flavored-markdown'
const markdown = new Markdown()
markdown.html("some *markdown*").then(html => console.log(html))
```

If you want a full html with html tag and css in the header:

```javascript
import Markdown from 'flavored-markdown'
const markdown = new Markdown(true)
markdown.html("some *markdown*").then(html => console.log(html))
```

Contribute
----------

You can find this project at this [GitHub repository][github]

How to use with VIM
-------------------

In your *vimrc* or *gvimrc*:

```vim
"Convert to html when save .md files
autocmd BufWritePost *.md :silent !flavored-markdown < '%:p' > /var/tmp/markdown.html

"Show the results with F9 key
autocmd BufNewFile,Bufread *.md imap <F9> <esc>:!google-chrome /var/tmp/markdown.html<cr>i
autocmd BufNewFile,Bufread *.md map <F9> :!google-chrome /var/tmp/markdown.html<cr>

"put a marker in char 80
autocmd BufNewFile,Bufread *.md set cc=80
```

This automatically create a temporary file */var/tmp/markdown.html* when you save your *.md* files.

### Syntax highlighting

If you are a VIM user and you want syntax highlighting or matching rules for
Markdowns, look at [this project][vimmarkdown].

[vimmarkdown]: https://github.com/plasticboy/vim-markdown
[github]: https://github.com/solispauwels/markdown

---
_Source: https://npm.io/package/flavored-markdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._