# batched-markdown

> Batch request markdown files from the file system and parse them using marked

Latest version **1.0.1** (published 2016-02-18) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-02-18 |
| First published | 2016-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Chris Lee |
| Maintainers | chrisls |
| Keywords | markdown, marked, fs, batch, multiple, markdown, html, md, .md |

## Links

- npm: https://www.npmjs.com/package/batched-markdown
- Repository: https://github.com/chrisleeshanok/batched-markdown
- Homepage: https://github.com/chrisleeshanok/batched-markdown#readme
- Issues: https://github.com/chrisleeshanok/batched-markdown/issues
- npm.io page: https://npm.io/package/batched-markdown

## Dependencies (2)

- [fs](https://npm.io/package/fs.md) 0.0.2
- [marked](https://npm.io/package/marked.md) ^0.3.5

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-02-18
- 1.0.0 — 2016-02-18

## README

# batched-markdown
Batch request markdown files in the file system, and parse them using marked.

## Installation
```
$ npm install batched-markdown
```

## Usage

#### parseFile
*returns a Promise object*

```
var BatchedMarkdown = require('batched-markdown');
var path = "/docs/markdown_file.md";

BatchedMarkdown.parseFile(path)
    .then(function(result) {
        //result contains an html string
    })
    .catch(function(err) {
        //fs or markedjs error
    });
```

#### parseFiles
*returns a Promise object*

```
var BatchedMarkdown = require('batched-markdown');
var paths = ["/docs/markdown_file1.md",
            "/docs/markdown_file1.md"];

BatchedMarkdown.parseFiles(paths)
    .then(function(result) {
        //result contains an array of html strings
    })
    .catch(function(err) {
        //fs or markedjs error from any of the files
    });
```

## Future Enhancements
- Ability to pass through a markedjs configuration object
- Ability to pull markdown from a API(s) rather than the filesystem

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