get-md-title

get title from markdown article

Usage no npm install needed!

<script type="module">
  import getMdTitle from 'https://cdn.skypack.dev/get-md-title';
</script>

README

get-md-title

NPM version Build Status Coveralls Status Dependency Status

get title from markdown article

Install

npm install --save get-md-title

Usage

import getTitle from 'get-md-title';

const input = `
# awesome *heading*

# second heading

paragragh`;

getTitle(input).text; // awesome heading
getTitle(input).html; // awesome <em>heading</em>
getTitle(input).node; // AST node, see commonmark API
getTitle('');         // undefined ¯\_(ツ)_/¯

API

getTitle(input)

input

Required
Type: String

Markdown string.

Related

License

MIT © Vladimir Starkov