litedown 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.es.js +4013 -0
- package/dist/index.umd.js +51 -0
- package/dist/vite.svg +1 -0
- package/package.json +75 -0
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# StreamdownLite
|
|
2
|
+
|
|
3
|
+
A lightweight, streaming-first Markdown renderer.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install litedown
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { render, useStreamdown } from 'litedown';
|
|
15
|
+
|
|
16
|
+
// Streaming hook
|
|
17
|
+
const { content, isLoading } = useStreamdown(markdownText);
|
|
18
|
+
|
|
19
|
+
// Direct rendering
|
|
20
|
+
const html = render(markdownText);
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
#### 6.2 Build and Test Locally
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# Build the library
|
|
28
|
+
npm run build
|
|
29
|
+
|
|
30
|
+
# Check dist folder contains:
|
|
31
|
+
# - index.js (ESM)
|
|
32
|
+
# - index.umd.cjs (CommonJS)
|
|
33
|
+
# - index.d.ts (TypeScript declarations)
|
|
34
|
+
# - index.css (Styles)
|
|
35
|
+
|
|
36
|
+
# Test locally
|
|
37
|
+
npm pack # Creates a tarball
|
|
38
|
+
npm install ./litedown-1.0.0.tgz # Test install
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Features
|
|
42
|
+
|
|
43
|
+
- Streaming-first architecture
|
|
44
|
+
- Native MathML support
|
|
45
|
+
- Prism syntax highlighting
|
|
46
|
+
- Callout support
|
|
47
|
+
- Mermaid diagrams
|
|
48
|
+
- TypeScript support
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
MIT © AbhinavTheDev
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {}
|