# @mdo-org/mdo-core

> Core logic for the MDo system.

Latest version **0.2.13** (published 2021-05-22) · SEE LICENSE IN ../../LICENSE license · 0 weekly downloads

## Install

```sh
npm install @mdo-org/mdo-core
pnpm add @mdo-org/mdo-core
yarn add @mdo-org/mdo-core
bun add @mdo-org/mdo-core
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.13 |
| Published | 2021-05-22 |
| First published | 2018-11-30 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN ../../LICENSE |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 459.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Alexis Hevia |
| Maintainers | alexishevia |

## Links

- npm: https://www.npmjs.com/package/@mdo-org/mdo-core
- Repository: https://github.com/mdo-org/mdo
- Homepage: https://github.com/mdo-org/mdo#readme
- Issues: https://github.com/mdo-org/mdo/issues
- npm.io page: https://npm.io/package/@mdo-org/mdo-core

## Dependencies (3)

- [luxon](https://npm.io/package/luxon.md) 1.27.0
- [pumpify](https://npm.io/package/pumpify.md) ^1.5.1
- [xregexp](https://npm.io/package/xregexp.md) ^4.2.4

## Recent versions

- 0.2.13 (latest) — 2021-05-22
- 0.2.12 — 2019-07-16
- 0.2.11 — 2019-06-30
- 0.2.10 — 2019-06-21
- 0.2.9 — 2019-05-27
- 0.2.8 — 2019-05-27
- 0.2.7 — 2019-05-26
- 0.2.6 — 2019-05-26
- 0.2.5 — 2019-05-26
- 0.2.3 — 2019-04-04
- 0.2.1 — 2019-04-02
- 0.2.0 — 2019-04-02
- 0.1.6 — 2019-03-18
- 0.1.5 — 2019-03-18
- 0.1.3 — 2019-03-18
- … 3 more at https://npm.io/package/@mdo-org/mdo-core/versions

## README

# mdo-core

mdo-core is meant to be used by MDo plugins and MDo flows.

If you are trying to use MDo to manage your to-dos, you probably want to look at
[mdo-cli](../mdo-cli/README.md).

## Overview

mdo-core contains logic for parsing and processing MDo files. It also exposes some helper methods for dealing (and testing) streams of MDo blocks.

## Usage

Stream mode

```
const fs = require('fs');
const MDo = require('@mdo-org/mdo-core');
const objectStream = fs.createReadStream('./myfile.md').pipe(MDo.parse());
```

String mode

```
const { parse, stringify } = require('@mdo-org/mdo-core/lib/strings')

parse('- [ ] hello world').then(blocks => console.log(blocks));

stringify([
  { type: 'INCOMPLETE_TASK', text: '{{type}} hello world'}
]).then(console.log)
```

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