# md-title

> get title from markdown article

Latest version **1.0.3** (published 2016-07-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install md-title
pnpm add md-title
yarn add md-title
bun add md-title
```

## 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.3 |
| Published | 2016-07-21 |
| First published | 2016-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Aleksandr Filatov |
| Maintainers | greybax |
| Keywords | md, markdown, remark, article, title |

## Links

- npm: https://www.npmjs.com/package/md-title
- Repository: https://github.com/greybax/md-title
- Homepage: https://github.com/greybax/md-title#readme
- Issues: https://github.com/greybax/md-title/issues
- npm.io page: https://npm.io/package/md-title

## Dependencies (1)

- [remark-helpers](https://npm.io/package/remark-helpers.md) ^0.0.4

## 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.3 (latest) — 2016-07-21
- 1.0.2 — 2016-07-08
- 1.0.1 — 2016-06-25
- 1.0.0 — 2016-06-25

## README

# md-title

[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Coveralls Status][coveralls-image]][coveralls-url]
[![Dependency Status][depstat-image]][depstat-url]

> get title from markdown article

## Install

    npm install --save md-title

## Usage

```js
import getTitle from 'md-title';

const input = `
# awesome *heading*

# second heading

paragragh`;

getTitle(input).text; // awesome heading
getTitle(input).html; // <h1>awesome <em>heading</em></h1>
getTitle(input).node; // mdast node, see remark API
getTitle('');         // undefined
```

## API

### getTitle(input)

#### input

*Required*  
Type: `String`

Markdown string.

## Related

* [md-article][md-article] - extract data from your markdown article
    * [md-content][md-content] - get content from markdown article
    * [md-date][md-date] - get date from markdown article
    * [md-tags][md-tags] - get tags from markdown article

## License

MIT © [Aleksandr Filatov](https://alfilatov.com)


[npm-url]: https://npmjs.org/package/md-title
[npm-image]: https://img.shields.io/npm/v/md-title.svg?style=flat-square

[travis-url]: https://travis-ci.org/greybax/md-title
[travis-image]: https://img.shields.io/travis/greybax/md-title.svg?style=flat-square

[coveralls-url]: https://coveralls.io/r/greybax/md-title
[coveralls-image]: https://img.shields.io/coveralls/greybax/md-title.svg?style=flat-square

[depstat-url]: https://david-dm.org/greybax/md-title
[depstat-image]: https://david-dm.org/greybax/md-title.svg?style=flat-square

[md-article]: https://github.com/greybax/md-article
[md-content]: https://github.com/greybax/md-content
[md-date]: https://github.com/greybax/md-date
[md-tags]: https://github.com/greybax/md-tags

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