@stoplight/markdown

Useful functions when working with Markdown.

Usage no npm install needed!

<script type="module">
  import stoplightMarkdown from 'https://cdn.skypack.dev/@stoplight/markdown';
</script>

README

@stoplight/markdown

Maintainability Test Coverage

Useful functions when working with Markdown. Leverages the Unified / Remark ecosystem under the hood.

Installation

Supported in modern browsers and node.

# latest stable
yarn add @stoplight/markdown

Usage

Example parse

import { parse } from '@stoplight/markdown';

const result = parse('**markdown**');

console.log(result); // => the MDAST compliant tree

Contributing

  1. Clone repo.
  2. Create / checkout feature/{name}, chore/{name}, or fix/{name} branch.
  3. Install deps: yarn.
  4. Make your changes.
  5. Run tests: yarn test.prod.
  6. Stage relevant files to git.
  7. Commit: yarn commit. NOTE: Commits that don't follow the conventional format will be rejected. yarn commit creates this format for you, or you can put it together manually and then do a regular git commit.
  8. Push: git push.
  9. Open PR targeting the develop branch.