# solidjs-markdown

> Markdown component for SolidJS

Latest version **0.2.0** (published 2023-02-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install solidjs-markdown
pnpm add solidjs-markdown
yarn add solidjs-markdown
bun add solidjs-markdown
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2023-02-19 |
| First published | 2023-02-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 178.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | enpitsulin |
| Maintainers | enpitsulin |
| Keywords | solidjs, markdown, mdx, solidjs-component, component, remark |

## Links

- npm: https://www.npmjs.com/package/solidjs-markdown
- npm.io page: https://npm.io/package/solidjs-markdown

## Dependencies (6)

- [vfile](https://npm.io/package/vfile.md) ^5.3.7
- [unified](https://npm.io/package/unified.md) ^10.1.2
- [solid-jsx](https://npm.io/package/solid-jsx.md) ^0.9.1
- [remark-parse](https://npm.io/package/remark-parse.md) ^10.0.1
- [remark-rehype](https://npm.io/package/remark-rehype.md) ^10.1.0
- [hast-util-to-jsx-runtime](https://npm.io/package/hast-util-to-jsx-runtime.md) ^1.2.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2023-02-19
- 0.1.0 — 2023-02-14

## README

<p>
  <img width="100%" src="https://assets.solidjs.com/banner?type=solidjs-markdown&background=tiles&project=%20" alt="solidjs-markdown">
</p>

# solidjs-markdown

Solidjs component to render markdown.

## Quick start

**Notice**: This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).

Install it with node:

```bash
npm i solidjs-markdown
# or
yarn add solidjs-markdown
# or
pnpm add solidjs-markdown
```

In Deno with `esm.sh`:

```bash
import SolidjsMarkdown from 'https://esm.sh/solidjs-markdown'
```

In broswer with `esm.sh`

```html
<script type="module">
  import SolidjsMarkdown from 'https://esm.sh/solidjs-markdown?bundle'
</script>
```

## Usage

```tsx
import SolidjsMarkdown from 'solidjs-markdown'
import { render } from 'solid-js/web'

render(() => <SolidjsMarkdown># Hello, *world*!</SolidjsMarkdown>, document.querySelector('#app'))
```

<details open="">
<summary>Show equivalent JSX</summary>

```jsx
<h1>
  Hello, <em>world</em>!
</h1>
```

</details>

## License

[MIT](https://github.com/enpitsuLin/solidjs-markdown/blob/HEAD/LICENSE) © [enpitsuLin](https://github.com/enpitsuLin)

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