# list-definition-markup

> Simple list format parser and converter.

Latest version **0.1.1** (published 2020-04-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install list-definition-markup
pnpm add list-definition-markup
yarn add list-definition-markup
bun add list-definition-markup
```

Provides the command `ldm`.

## 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.1.1 |
| Published | 2020-04-10 |
| First published | 2020-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Joaquim Neto |
| Maintainers | popon |

## Links

- npm: https://www.npmjs.com/package/list-definition-markup
- npm.io page: https://npm.io/package/list-definition-markup

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [yargs](https://npm.io/package/yargs.md) ^15.3.1

## Recent versions

- 0.1.1 (latest) — 2020-04-10
- 0.1.0 — 2020-04-07

## README

# Welcome to list-definition-markup 👋

![Version](https://img.shields.io/badge/version-0.1.0-blue.svg?cacheSeconds=2592000)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#)
[![Twitter: joaquimnet_](https://img.shields.io/twitter/follow/joaquimnet_.svg?style=social)](https://twitter.com/joaquimnet_)

> Simple list format parser and converter.

## Install

```sh
yarn install list-definition-markup
```

## Usage

```sh
ldm <path> [--output="file name or path"] [--verbose] [--dry]
```

or

```javascript
const parse = require('list-definition-markup');

// parse() returns the ldm content parsed as a javascript object
const parsedObject = parse(someLdmText);
```

## Example

```sh
ldm my-house.ldm
```

-> my-house.ldm

```ldm
house
  living room
  kitchen
  bathroom
  room
    tv
    bed
```

-> my-house.json

```json
{
  "house": {
    "living room": "living room",
    "kitchen": "kitchen",
    "bathroom": "bathroom",
    "room": {
      "tv": "tv",
      "bed": "bed"
    }
  }
}
```

## Run tests

```sh
yarn test
```

## Author

👤 **Joaquim Neto**

- Twitter: [@joaquimnet\_](https://twitter.com/joaquimnet_)
- Github: [@joaquimnet](https://github.com/joaquimnet)

## Show your support

Give a ⭐️ if this project helped you!

---

_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

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