# read-md-safe

> Read markdown files as a Marked token list or string

Latest version **1.0.5** (published 2022-01-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install read-md-safe
pnpm add read-md-safe
yarn add read-md-safe
bun add read-md-safe
```

## 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.5 |
| Published | 2022-01-17 |
| First published | 2020-09-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Connor White |
| Maintainers | bconnorwhite |
| Keywords | read, markdown, md, parse, safe, without, try, catch, json |

## Links

- npm: https://www.npmjs.com/package/read-md-safe
- Repository: https://github.com/bconnorwhite/read-md-safe
- Homepage: https://connorwhite.org/github/read-md-safe
- npm.io page: https://npm.io/package/read-md-safe

## Dependencies (2)

- [marked](https://npm.io/package/marked.md) ^4.0.10
- [read-file-safe](https://npm.io/package/read-file-safe.md) ^1.0.10

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.5 (latest) — 2022-01-17
- 1.0.4 — 2021-03-30
- 1.0.3 — 2020-10-11
- 1.0.2 — 2020-09-30
- 1.0.1 — 2020-09-07
- 1.0.0 — 2020-09-07

## README

<div align="center">
  <h1>read-md-safe</h1>
  <a href="https://npmjs.com/package/read-md-safe">
    <img alt="NPM" src="https://img.shields.io/npm/v/read-md-safe.svg">
  </a>
  <a href="https://github.com/bconnorwhite/read-md-safe">
    <img alt="TypeScript" src="https://img.shields.io/github/languages/top/bconnorwhite/read-md-safe.svg">
  </a>
  <a href='https://coveralls.io/github/bconnorwhite/read-md-safe?branch=master'>
    <img alt="Coverage Status" src="https://img.shields.io/coveralls/github/bconnorwhite/read-md-safe.svg?branch=master">
  </a>
  <a href="https://github.com/bconnorwhite/read-md-safe">
    <img alt="GitHub Stars" src="https://img.shields.io/github/stars/bconnorwhite/read-md-safe?label=Stars%20Appreciated%21&style=social">
  </a>
  <a href="https://twitter.com/bconnorwhite">
    <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/bconnorwhite.svg?label=%40bconnorwhite&style=social">
  </a>
</div>

<br />

> Read markdown files as a [Marked](https://www.npmjs.com/package/marked) token list or string.

## Installation

```sh
yarn add read-md-safe
```

```sh
npm install read-md-safe
```

## API

### Types
```ts
import {
  readMarkdown,
  readMarkdownSync,
  readMarkdownString,
  readMarkdownStringSync,
  TokensList,
  Token
} from "write-file-safe";

function readMarkdown(path: string): Promise<TokensList | undefined>;

function readMarkdownSync(path: string): TokensList | undefined;

function readMarkdownString(path: string): Promise<string | undefined>;

function readMarkdownStringSync(path: string): string | undefined;

// a Marked token list
type TokensList = Token[] & {
  links: {
    [key: string]: {
      href: string | null;
      title: string | null;
    };
  };
}
```

<br />

<h2>Dependencies<img align="right" alt="dependencies" src="https://img.shields.io/david/bconnorwhite/read-md-safe.svg"></h2>

- [@types/marked](https://www.npmjs.com/package/@types/marked): TypeScript definitions for Marked
- [marked](https://www.npmjs.com/package/marked): A markdown parser built for speed
- [read-file-safe](https://www.npmjs.com/package/read-file-safe): Read files without try catch.

<br />

<h2>Dev Dependencies<img align="right" alt="David" src="https://img.shields.io/david/dev/bconnorwhite/read-md-safe.svg"></h2>

- [@bconnorwhite/bob](https://www.npmjs.com/package/@bconnorwhite/bob): Bob is a toolkit for TypeScript projects
- [@types/mock-fs](https://www.npmjs.com/package/@types/mock-fs): TypeScript definitions for mock-fs
- [mock-fs](https://www.npmjs.com/package/mock-fs): A configurable mock file system.  You know, for testing.

<br />

<h2>License <img align="right" alt="license" src="https://img.shields.io/npm/l/read-md-safe.svg"></h2>

[MIT](https://opensource.org/licenses/MIT)

<br />

## Related Packages:

- [marked](https://www.npmjs.com/package/marked): A markdown parser built for speed
- [write-md-safe](https://npmjs.com/package/read-md-safe): Write markdown files from a Marked token list or string.
- [read-file-safe](https://www.npmjs.com/package/read-file-safe): Read files without try catch.

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