open-index/open-npm huggingface dataset:
npm package: @md-parser/html-renderer
Description: HTML renderer for parsed markdown
Author: Marten de Groot
Latest version: 0.1.0

# markdown-parser

## Install

```sh
yarn add @md-parser/html-renderer
```

## Usage

```ts
import { renderHTML } from '@md-parser/html-renderer';

const html = renderHTML('# Hello World');
```

### Presets

```ts
import { parseMarkdown, GFM } from '@saartje87/md-ast';

const ast = renderHTML('# Hello World', {
  presets: [GFM()],
});
```

See [@md-parser/parser](https://github.com/md-parser/parser) for more options options.
npm package: @md-parser/parser
Description: Markdown parser
Author: Niek Saarberg
Latest version: 0.11.1

# markdown-parser

## What is this?

Markdown parser that returns an AST (Abstract Syntax Tree) of the markdown document.

## What is different?

- Line breaks are always hard breaks
- No inline HTML
- Output is not sanitized
- Headings can only be defined by `#` characters

### Line breaks

Line breaks are always hard breaks. This means that a line break in the markdown document will always result in a `<br />` tag in the HTML output.
No additional spaces or slashes are required.

```md
Hello
World
```

```html
<p>Hello<br />World</p>
```

### Headings

Headings can only be defined by `#` characters. This means that headings cannot be defined by underlines or `=` characters.

Valid:

```md
# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6
```

Invalid:

```md
# Heading 1
```

## Inline HTML

Inline HTML is parsed as is. This means that the HTML is not parsed as markdown. To prevent security vulnerabilities, the markdown renderer should sanitize the output.

### Sanitization

In a markdown parser, "sanitized output" refers to removing or encoding potentially harmful HTML or code to prevent security vulnerabilities. This is not the job of a markdown parser. This is the job of a markdown renderer. This parser only returns an AST. It is up to the renderer to sanitize the output.

## Install

```sh
yarn add @md-parser/parse
```

## How to use

```ts
import { parseMarkdown } from '@md-parser/parse';

const ast = parseMarkdown('# Hello World');

// ast = [
//   {
//     "type": "heading",
//     "level": 1,
//     "children": [
//       {
//         "type": "text",
//         "value": "Hello World"
//       }
//     ]
//   }
// ]
```

## Configuration

### GitHub Flavored Markdown

```ts
import { parseMarkdown, GFM } from '@md-parser/parse';

const ast = parseMarkdown('# Hello World', {
  presets: [GFM()],
});
```
npm package: @md-parser/react
Description: React markdown parser
Author: Dillon Parfitt
Latest version: 1.0.5

# Markdown AST to React Node

This package provides a utility for converting Markdown AST nodes to React nodes. It exports two components: `MarkdownRenderer` and `MarkdownASTRenderer`, as well as a set of types.

## Installation

````sh
npm install @md-parser/react

```sh
yarn add @md-parser/react
````

## Usage

### Define components

See the components defined in the [examples](examples/next/src/components/Renderers.tsx ':include :type=code typescript')

```tsx
import { MarkdownRenderer } from '@md-parser/react';
import { components } from './components';

export const Markdown = ({ markdown }: { markdown: string }) => (
  <MarkdownRenderer components={components}>{markdown}</MarkdownRenderer>;
)
```
npm package: @md-plugins/md-plugin-blockquote
Description: A markdown-it plugin for Blockquotes with custom styles.
Author: hawkeye64
Latest version: 0.1.0-alpha.29

# @md-plugins/md-plugin-blockquote

A **Markdown-It** plugin that enhances blockquote rendering by adding customizable CSS classes. This allows for easier styling and alignment with design systems, enabling more visually appealing and consistent blockquote presentation.

## Features

- Adds customizable CSS classes to `<blockquote>` elements.
- Supports a default class that can be overridden via plugin options.

## Installation

Install the plugin via your preferred package manager:

```bash
# with pnpm:
pnpm add @md-plugins/md-plugin-blockquote
# with Yarn:
yarn add @md-plugins/md-plugin-blockquote
# with npm:
npm install @md-plugins/md-plugin-blockquote
```

## Usage

### Basic Setup

```js
import MarkdownIt from 'markdown-it'
import { blockquotePlugin } from 'md-plugin-blockquote'

const md = new MarkdownIt()
md.use(blockquotePlugin, {
  blockquoteClass: 'custom-blockquote',
})

const markdownContent = `
> This is a blockquote.
`

const renderedOutput = md.render(markdownContent)

console.log('Rendered Output:', renderedOutput)
```

### Example Output

The rendered output will include the specified CSS class:

```html
<blockquote class="custom-blockquote">
  <p>This is a blockquote.</p>
</blockquote>
```

## Options

The `md-plugin-blockquote` plugin supports the following options:

| Option          | Type   | Default               | Description                        |
| --------------- | ------ | --------------------- | ---------------------------------- |
| blockquoteClass | string | 'markdown-blockquote' | CSS class to apply to blockquotes. |

## Testing

To run the tests, use the following command:

```bash
pnpm test
```

## Documentation

In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/blockquote/overview) for the latest information.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.
npm package: @md-plugins/md-plugin-image
Description: A markdown-it plugin for handling images.
Author: hawkeye64
Latest version: 0.1.0-alpha.29

# @md-plugins/md-plugin-image

A **Markdown-It** plugin that enhances image rendering by adding customizable CSS classes. This allows for consistent styling and seamless integration into design systems, making it easy to apply specific layouts or effects to images.

## Features

- Adds a customizable CSS class to `<img>` elements.
- Supports a default class that can be overridden via plugin options.
- Enhances image styling and layout consistency.

## Installation

Install the plugin via your preferred package manager:

```bash
# with pnpm:
pnpm add @md-plugins/md-plugin-image
# with Yarn:
yarn add @md-plugins/md-plugin-image
# with npm:
npm install @md-plugins/md-plugin-image
```

## Usage

### Basic Setup

```js
import MarkdownIt from 'markdown-it'
import { imagePlugin } from '@md-plugins/md-plugin-image'

const md = new MarkdownIt()
md.use(imagePlugin, {
  imageClass: 'custom-image-class',
})

const markdownContent = `
![Alt text](example.jpg)
`

const renderedOutput = md.render(markdownContent)

console.log('Rendered Output:', renderedOutput)
```

### Example Output

The rendered output will include the specified CSS class:

```html
<img src="example.jpg" alt="Alt text" class="custom-image-class" />
```

## Options

The `md-plugin-image` plugin supports the following options:

| Option     | Type   | Default          | Description                            |
| ---------- | ------ | ---------------- | -------------------------------------- |
| imageClass | string | 'markdown-image' | CSS class to apply to all `<img>` tags |

## Testing

Run the tests to ensure the plugin behaves as expected:

```bash
pnpm test
```

## Documentation

In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/image/overview) for the latest information.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.
npm package: @md-plugins/md-plugin-inlinecode
Description: A markdown-it plugin for handling inline code.
Author: hawkeye64
Latest version: 0.1.0-alpha.29

# @md-plugins/md-plugin-inlinecode

A **Markdown-It** plugin that enhances inline code rendering by adding customizable CSS classes. This allows for better styling and alignment with design systems, making inline code blocks visually distinct and consistent.

## Features

- Adds a customizable CSS class to inline `<code>` elements.
- Supports a default class that can be overridden via plugin options.
- Enhances the appearance of inline code for better readability and emphasis.

## Installation

Install the plugin via your preferred package manager:

```bash
# with pnpm:
pnpm add @md-plugins/md-plugin-inlinecode
# with Yarn:
yarn add @md-plugins/md-plugin-inlinecode
# with npm:
npm install @md-plugins/md-plugin-inlinecode
```

## Usage

### Basic Setup

```js
import MarkdownIt from 'markdown-it'
import { inlinecodePlugin } from '@md-plugins/md-plugin-inlinecode'

const md = new MarkdownIt()
md.use(inlinecodePlugin, {
  inlineCodeClass: 'custom-inline-code-class',
})

const markdownContent = `
Here is some \`inline code\` in a sentence.
`

const renderedOutput = md.render(markdownContent)

console.log('Rendered Output:', renderedOutput)
```

### Example Output

The rendered output will include the specified CSS class:

```html
<p>Here is some <code class="custom-inline-code-class">inline code</code> in a sentence.</p>
```

## Options

The `md-plugin-inlinecode` plugin supports the following options:

| Option          | Type   | Default          | Description                                 |
| --------------- | ------ | ---------------- | ------------------------------------------- |
| inlineCodeClass | string | 'markdown-token' | CSS class to apply to inline `<code>` tags. |

## Testing

Run the tests to ensure the plugin behaves as expected:

```bash
pnpm test
```

## Documentation

In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/inline-code/overview) for the latest information.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.
npm package: @md-plugins/md-plugin-title
Description: A markdown-it plugin for getting Title information.
Author: hawkeye64
Latest version: 0.1.0-alpha.29

# @md-plugins/md-plugin-title

A **Markdown-It** plugin that extracts the first `<h1>` title from Markdown content and stores it in the Markdown-It environment (`env`). This is particularly useful for generating page titles dynamically or for metadata extraction in documentation and content management systems.

## Features

- Extracts the first `<h1>` from Markdown content.
- Stores the extracted title in the `title` property of the Markdown-It environment (`env`).
- Provides flexibility to handle scenarios with or without a title.
- Seamlessly integrates into content pipelines for title-based features.

## Installation

Install the plugin via your preferred package manager:

```bash
# with pnpm:
pnpm add @md-plugins/md-plugin-title
# with Yarn:
yarn add @md-plugins/md-plugin-title
# with npm:
npm install @md-plugins/md-plugin-title
```

## Usage

### Basic Setup

```js
import MarkdownIt from 'markdown-it';
import { titlePlugin } from '@md-plugins/md-plugin-title';
import type { MarkdownItEnv } from '@md-plugins/shared';

const md = new MarkdownIt();
md.use(titlePlugin);

const markdownContent = `
# This is the Page Title

Some content here.
`;

const env: MarkdownItEnv = {};
const renderedOutput = md.render(markdownContent, env);

console.log('Rendered Output:', renderedOutput);
console.log('Extracted Title:', env.title);
```

### Example Output

For the example above, the `env` will contain the following:

```json
{
  "title": "This is the Page Title"
}
```

And the rendered Markdown output will appear as usual:

```html
<h1>This is the Page Title</h1>
<p>Some content here.</p>
```

## Options

The `md-plugin-title` plugin does not currently accept configuration options. It automatically extracts the first `<h1>` element.

## Note

This plugin is not needed is using the `@md-plugins/md-plugin-frontmatter` plugin.

## Testing

Run the tests to ensure the plugin behaves as expected:

```bash
pnpm test
```

## Documentation

In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/title/overview) for the latest information.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.
npm package: @md-plugins/shared
Description: Shared functions and utilities for md-plugins.
Author: hawkeye64
Latest version: 0.1.0-alpha.29

# @md-plugins/shared

The `@md-plugins/shared` package provides common utilities, types, and helpers used across various Markdown-It plugins in the `@md-plugins` ecosystem. It serves as a foundational package to ensure consistency and reduce code duplication across the plugins.

## Features

- Shared TypeScript types for plugin environments.
- Common utility functions for Markdown-It processing.
- Centralized definitions for easier maintenance and reusability.
- Lightweight and dependency-free.

## Installation

Install the plugin via your preferred package manager:

```bash
# with pnpm:
pnpm add @md-plugins/shared
# with Yarn:
yarn add @md-plugins/shared
# with npm:
npm install @md-plugins/shared
```

## Usage

The `@md-plugins/shared` package is not intended to be used directly by end-users but as a dependency for other `@md-plugins` packages. However, if you’re developing a custom plugin or extending existing functionality, you can import and use the utilities provided.

## Example: Accessing Types

```ts
import type { MarkdownItEnv } from '@md-plugins/shared'

const env: MarkdownItEnv = {
  toc: [],
  frontmatter: {},
}
```

## Example: Utility Function

```ts
import { resolveTitleFromToken } from '@md-plugins/shared'

const token = { content: '# My Title' }
const title = resolveTitleFromToken(token, {
  shouldAllowHtml: false,
  shouldEscapeText: true,
})

console.log(title) // "My Title"
```

## Provided Types

The `shared` package defines common types used across plugins. Here are some examples:

### `MarkdownItEnv`

```ts
export interface MarkdownItEnv {
  toc?: Array<Record<string, any>> // Extracted table of contents
  frontmatter?: Record<string, unknown> // Frontmatter data
  pageScripts?: Set<string> // Scripts to be included in the page
  content?: string // Markdown content excluding frontmatter
  title?: string // Extracted title
}
```

This type allows consistent management of the Markdown-It environment.

## Utility Functions

### `resolveTitleFromToken`

A utility function to resolve the title from a Markdown-It token.

```ts
function resolveTitleFromToken(
  token: Token,
  options: { shouldAllowHtml: boolean; shouldEscapeText: boolean },
): string
```

- Parameters:
  - token: The Markdown-It token to extract the title from.
  - options: Configuration for allowing HTML or escaping text.
- Returns: The resolved title as a string

### `slugify`

Provides a standard implementation of slugification for plugins:

```ts
function slugify(str: string): string
```

- Converts a string into a URL-friendly slug.
- Removes special characters and replaces spaces with hyphens.

## Documentation

In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/md-plugins/shared/overview) for the latest information.

## License

This package is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
npm package: @md-reader/markdown-it-mermaid
Description: Forked Package markdown-it-mermaid.
Author: Tyler Long
Latest version: 0.6.0-beta.0

([Forked](https://github.com/liradb2000/markdown-it-mermaid))[Mermaid plugin for markdown-it](https://github.com/tylingsoft/markdown-it-mermaid).

## 0.5.0
-   Update [Mermaid-js](https://mermaid-js.github.io/mermaid/#/) 9.0.0+

## Installation

```
npm install @md-reader/markdown-it-mermaid
```

## Usage

```js
import markdownIt from "markdown-it";
import markdownItMermaid from "@md-reader/markdown-it-mermaid";
const mdi = markdownIt();
mdi.use(markdownItMermaid);
mdi.render(`~~~mermaid
  graph TD
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[Car]
~~~`);
```

The word `mermaid` after the fence code block opening indicates that the
rest of the fenced block should be passed to mermaid for processing.
This example used the `~~~` fence marker since the multi-line string
in javascript is the same character,
but either `~~~` or ` ``` ` works.

## Customize mermaid

```js
import MarkdownIt from 'markdown-it';
import MarkdownItMermaid from '@md-reader/markdown-it-mermaid';

var md = MarkdownIt({
        html: false,
        linkify: true,
        typographer: true,
        breaks: true,
        xhtmlOut: false,
    });

md.use(MarkdownItMermaid,{
  startOnLoad: false,
  securityLevel: true,
  theme: "default",
  flowchart:{
    htmlLabels: false,
    useMaxWidth: true,
  },
  dictionary:{
    token: "mermaid",
    graph:"graph",
    sequenceDiagram: "sequenceDiagram",
  }
  ...or any options
})
```

### Dictionary option (New ver. 0.4.3)

````
```mermaid (<- token)
graph TD (<- Replacable)
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[Car]
```
````

-   Example
If you setup like below,
```javascript
md.use(MarkdownItMermaid,{
  ...,
  dictionary:{
    token: "diagram",
    gra:"graph",
    seq:"sequenceDiagram",
    seqDiagram: "sequenceDiagram",
  }
  ...or any options
})
```

you can use like
````
```diagram
gra TD
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[Car]
```

or

```diagram
seq
    participant John
    participant Alice
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!
```

or

```diagram
seqDiagram
    participant John
    participant Alice
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!
```

````

## ✔Migrate v0.3.x to v0.4.x

Change the token (like grpah TD, sequenceDiagram or something) to "mermaid"!

```js
- mdi.render(`\`\`\`graph TD
+ mdi.render(`\`\`\`mermaid
+  graph TD
    A[Christmas] -->|Get money| B(Go shopping)
    B --> C{Let me think}
    C -->|One| D[Laptop]
    C -->|Two| E[iPhone]
    C -->|Three| F[Car]
\`\`\``);
```

## Alternative packages

-   https://github.com/DatatracCorporation/markdown-it-mermaid
    -   (Recommend) Supports title and more rich funcs!

## Thanks to

@DatatracCorporation
@nojaja
npm package: @md-ui/avatar
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/avatar`

> TODO: description

## Usage

```
const avatar = require('@md-ui/avatar');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/badge
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/badge`

> TODO: description

## Usage

```
const badge = require('@md-ui/badge');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/breadcrumb
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/breadcrumb`

> TODO: description

## Usage

```
const breadcrumb = require('@md-ui/breadcrumb');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/button
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/button`

> TODO: description

## Usage

```
const button = require('@md-ui/button');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/can-use-dom
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/can-use-dom`

> TODO: description

## Usage

```
const canUseDom = require('@md-ui/can-use-dom');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/card
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/card`

> TODO: description

## Usage

```
const card = require('@md-ui/card');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/checkbox
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/checkbox`

> TODO: description

## Usage

```
const checkbox = require('@md-ui/checkbox');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/classname
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/classname`

> TODO: description

## Usage

```
const classname = require('@md-ui/classname');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/container
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/container`

> TODO: description

## Usage

```
const container = require('@md-ui/container');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/core
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/core`

> TODO: description

## Usage

```
const core = require('@md-ui/core');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/delay
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/delay`

> TODO: description

## Usage

```
const delay = require('@md-ui/delay');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/divider
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/divider`

> TODO: description

## Usage

```
const divider = require('@md-ui/divider');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/docs
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/docs`

> TODO: description

## Usage

```
const docs = require('@md-ui/docs');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/drawer
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/drawer`

> TODO: description

## Usage

```
const drawer = require('@md-ui/drawer');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/env
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/env`

> TODO: description

## Usage

```
const env = require('@md-ui/env');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/icon
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/icon`

> TODO: description

## Usage

```
const icon = require('@md-ui/icon');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/image
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/image`

> TODO: description

## Usage

```
const image = require('@md-ui/image');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/input
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/image`

> TODO: description

## Usage

```
const image = require('@md-ui/image');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/md-build
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/md-build`

> TODO: description

## Usage

```
const build = require('@md-ui/md-build');

// TODO: DEMONSTRATE API
```

## Features

- Support TypeScript.
- Support JSX.
- Support optional chaining && nullish coalescing operator.
- Support css/scss.
npm package: @md-ui/modal
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/modal`

> TODO: description

## Usage

```
const modal = require('@md-ui/modal');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/notification
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/notification`

> TODO: description

## Usage

```
const notification = require('@md-ui/notification');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/pagination
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/pagination`

> TODO: description

## Usage

```
const pagination = require('@md-ui/pagination');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/popper
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/popper`

> TODO: description

## Usage

```
const popper = require('@md-ui/popper');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/progress
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/progress`

> TODO: description

## Usage

```
const progress = require('@md-ui/progress');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/radio
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/radio`

> TODO: description

## Usage

```
const radio = require('@md-ui/radio');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/react-ref
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/react-ref`

> TODO: description

## Usage

```
const reactRef = require('@md-ui/react-ref');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/select
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/select`

> TODO: description

## Usage

```
const select = require('@md-ui/select');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/skeleton
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/skeleton`

> TODO: description

## Usage

```
const skeleton = require('@md-ui/skeleton');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/styles
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/styles`

> TODO: description

## Usage

```
const styles = require('@md-ui/styles');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/switch
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/switch`

> TODO: description

## Usage

```
const switch = require('@md-ui/switch');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/table
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/table`

> TODO: description

## Usage

```
const table = require('@md-ui/table');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/tag
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/tag`

> TODO: description

## Usage

```
const tag = require('@md-ui/tag');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/theme
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/theme`

> TODO: description

## Usage

```
const theme = require('@md-ui/theme');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/use-outside-click
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/use-outside-click`

> TODO: description

## Usage

```
const useOutsideClick = require('@md-ui/use-outside-click');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/use-safe-layout-effect
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/use-safe-layout-effect`

> TODO: description

## Usage

```
const useSafeLayoutEffect = require('@md-ui/use-safe-layout-effect');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/use-scroll-lock
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/use-scroll-lock`

> TODO: description

## Usage

```
const useScrollLock = require('@md-ui/use-scroll-lock');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/use-stack
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/use-stack`

> TODO: description

## Usage

```
const useStack = require('@md-ui/use-stack');

// TODO: DEMONSTRATE API
```
npm package: @md-ui/use-uncontrolled
Description: Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth i
Author: Flcwl
Latest version: 1.0.0

# `@md-ui/use-uncontrolled`

> TODO: description

## Usage

```
const useUncontrolled = require('@md-ui/use-uncontrolled');

// TODO: DEMONSTRATE API
```