https://github.com/enpitsulin/solidjs-markdown
Markdown component for SolidJS
https://github.com/enpitsulin/solidjs-markdown
Last synced: 6 months ago
JSON representation
Markdown component for SolidJS
- Host: GitHub
- URL: https://github.com/enpitsulin/solidjs-markdown
- Owner: enpitsuLin
- License: mit
- Created: 2023-02-13T14:17:51.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T04:16:37.000Z (about 2 years ago)
- Last Synced: 2025-01-22T19:48:17.967Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 671 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
import SolidjsMarkdown from 'https://esm.sh/solidjs-markdown?bundle'
```
## Usage
```tsx
import SolidjsMarkdown from 'solidjs-markdown'
import { render } from 'solid-js/web'
render(() => # Hello, *world*!, document.querySelector('#app'))
```
Show equivalent JSX
```jsx
Hello, world!
```
## License
[MIT](https://github.com/enpitsuLin/solidjs-markdown/blob/HEAD/LICENSE) © [enpitsuLin](https://github.com/enpitsuLin)