# markdown-pane

> A SolidOS pane to render, create and edit markdown files.

Latest version **0.2.1** (published 2021-11-04) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2021-11-04 |
| First published | 2020-12-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 15.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | michielbdejong, timbl, aveltens, bourgeoa |
| Keywords | solid, markdown, pane, solid-panes, solidos |

## Links

- npm: https://www.npmjs.com/package/markdown-pane
- Repository: https://github.com/solid/markdown-pane
- Homepage: https://github.com/solid/markdown-pane#readme
- Issues: https://github.com/solid/markdown-pane/issues
- npm.io page: https://npm.io/package/markdown-pane

## Dependencies (6)

- [rdflib](https://npm.io/package/rdflib.md) ^2.2.10
- [fsevents](https://npm.io/package/fsevents.md) ^2.3.2
- [solid-ui](https://npm.io/package/solid-ui.md) ^2.4.11
- [pane-registry](https://npm.io/package/pane-registry.md) ^2.4.3
- [react-markdown](https://npm.io/package/react-markdown.md) ^5.0.3
- [@babel/preset-react](https://npm.io/package/@babel/preset-react.md) ^7.16.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2021-11-04
- 0.2.1-ea9010e9 (main) — 2026-01-28
- 0.2.1-01c74112 (9-merge) — 2026-01-23
- 0.1.2-8b93a13b (6-merge) — 2021-10-21
- 0.1.2-fa524247 (request-markdown) — 2021-10-18
- 0.2.0-767a1cf4 — 2021-10-22
- 0.2.0 — 2021-10-22
- 0.1.2-6d1f6614 — 2021-10-22
- 0.1.2-dc5a59db — 2021-10-20
- 0.1.2-b50c4262 — 2021-10-18
- 0.1.2-01cdd4d5 — 2021-10-18
- 0.1.2 — 2021-10-15
- 0.1.2-beta — 2021-10-08
- 0.1.1 — 2020-12-04
- 0.1.0 — 2020-12-04

## README

# markdown-pane

A SolidOS pane to render, create and edit markdown files.

## Contribute

### Tech stack

- Typescript
- React
- Jest
- Eslint
- Prettier
- SolidOS

### Tests

To run all tests:
```shell script
npm run test
```

#### Unit tests

Unit tests use `jest` and are placed next to the tested file as `*.test.ts(x)` files.

### Dev Server

Start a webpack dev server:

```shell script
npm start
```

Visit `http://localhost:8080/` to render the pane.
 
### Build

```
npm run build
```

The build is done by `tsc`, webpack is only used as dev server and not for production build.

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