# get-title-markdown

> get title from markdown.

Latest version **2.0.1** (published 2014-09-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install get-title-markdown
pnpm add get-title-markdown
yarn add get-title-markdown
bun add get-title-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 | 2.0.1 |
| Published | 2014-09-28 |
| First published | 2014-09-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | azu |
| Maintainers | azu |

## Links

- npm: https://www.npmjs.com/package/get-title-markdown
- Repository: https://github.com/azu/get-title-markdown
- Homepage: https://github.com/azu/get-title-markdown/
- Issues: https://github.com/azu/get-title-markdown/issues
- npm.io page: https://npm.io/package/get-title-markdown

## Recent versions

- 2.0.1 (latest) — 2014-09-28
- 2.0.0 — 2014-09-28

## README

# get-title-markdown [![Build Status](https://travis-ci.org/azu/get-title-markdown.svg)](https://travis-ci.org/azu/get-title-markdown)

Get `# title` content from Markdown string.

HTML Version : [azu/get-html-title](https://github.com/azu/get-html-title/ "azu/get-html-title")

## Installation

``` console
npm install get-title-markdown
```

## Usage

**test.md**

```html
# Title

test text
```

Get title content from above markdown.

```javascript
var getTitle = require("get-title-markdown");
var content = fs.readFileSync(__dirname + "/test.md", "utf-8");
getTitle(content); // => "Title"
```

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## License

MIT

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