# @stackline/types-mdast

> TypeScript definitions for mdast.

[![npm version](https://img.shields.io/npm/v/@stackline/types-mdast.svg?style=flat-square)](https://www.npmjs.com/package/@stackline/types-mdast)
[![license](https://img.shields.io/npm/l/@stackline/types-mdast.svg?style=flat-square)](https://github.com/alexandroit/stackline-types-mdast)
[![GitHub repository](https://img.shields.io/badge/GitHub-repository-181717?style=flat-square&logo=github)](https://github.com/alexandroit/stackline-types-mdast)
[![Docs](https://img.shields.io/badge/docs-alexandro.net-0f766e?style=flat-square)](https://alexandro.net/docs/vanilla/types-mdast/)
[![Reddit community](https://img.shields.io/badge/community-r%2FStackline-ff4500?style=flat-square&logo=reddit&logoColor=white)](https://www.reddit.com/r/Stackline/)

**[Documentation](https://alexandro.net/docs/vanilla/types-mdast/)** | **[npm](https://www.npmjs.com/package/@stackline/types-mdast)** | **[Issues](https://github.com/alexandroit/stackline-types-mdast/issues)** | **[Repository](https://github.com/alexandroit/stackline-types-mdast)**

**Current package version:** `1.0.2`

---

## Why this package?

`@stackline/types-mdast` is the Stackline-maintained distribution of `@types/mdast@3.0.15`. It is an independent continuation of [@types/mdast](https://github.com/DefinitelyTyped/DefinitelyTyped); original authors and licenses remain credited below.

## Compatibility

| Item | Value |
| :--- | :--- |
| Package | `@stackline/types-mdast@1.0.2` |
| API target | `@types/mdast@3.0.15` |
| Supported Node.js | `See supported framework requirements` |
| License | `MIT` |
| Types | `index.d.ts` |
| Runtime dependencies | `@types/unist` |

## Installation

```bash
npm install --save-dev @stackline/types-mdast
```

Preserve existing imports and plugin resolution with an npm alias:

```bash
npm install --save-dev @types/mdast@npm:@stackline/types-mdast
```

Use the original `@types/*` alias for automatic TypeScript type discovery and existing `compilerOptions.types` settings. A scoped-only installation does not automatically expose the original type-package name.

## Usage and API reference

### Installation
> `npm install --save @stackline/types-mdast`

### Summary
This package contains type definitions for mdast (https://github.com/syntax-tree/mdast).

### Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mdast/v3.

### Additional Details
 * Last updated: Tue, 07 Nov 2023 20:08:00 GMT
 * Dependencies: [@types/unist](https://npmjs.com/package/@types/unist)

### Credits
These definitions were written by [Christian Murphy](https://github.com/ChristianMurphy), [Jun Lu](https://github.com/lujun2), [Remco Haszing](https://github.com/remcohaszing), and [Titus Wormer](https://github.com/wooorm).

## Credits and original authors

- Original project: [@types/mdast](https://github.com/DefinitelyTyped/DefinitelyTyped).
- Christian Murphy.
- Jun Lu.
- Remco Haszing.
- Titus Wormer.
- Stackline maintenance: [Alexandro Paixao Marques](https://www.linkedin.com/in/aleinfo/) and [Stackline contributors](https://github.com/alexandroit).

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

## License

`MIT`. See the license and notice files in the [repository](https://github.com/alexandroit/stackline-types-mdast).

## Community and Links

- [Stackline website](https://alexandro.net/)
- [GitHub projects](https://github.com/alexandroit)
- [npm packages](https://www.npmjs.com/~alex360qc)
- [Reddit community — r/Stackline](https://www.reddit.com/r/Stackline/)
- [Maintainer LinkedIn](https://www.linkedin.com/in/aleinfo/)

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.


Documentation-only release: runtime file bytes and dependencies are unchanged from 1.0.0.
Release: https://github.com/alexandroit/stackline-types-mdast/releases/tag/docs-stackline-types-mdast-v1.0.2