@vaneui/md 0.0.1-alpha.20250730123353.cc58664

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 ADDED
@@ -0,0 +1,71 @@
1
+ # @vaneui/md
2
+
3
+ A React component for rendering Markdown content using @vaneui/ui components.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @vaneui/md @vaneui/ui
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```tsx
14
+ import React from 'react';
15
+ import { Markdown } from '@vaneui/md';
16
+
17
+ const App = () => {
18
+ const markdownContent = `
19
+ # Hello World
20
+
21
+ This is a **markdown** component that uses VaneUI components.
22
+
23
+ - Item 1
24
+ - Item 2
25
+ - Item 3
26
+
27
+ > This is a blockquote
28
+
29
+ \`\`\`
30
+ console.log('Code block');
31
+ \`\`\`
32
+ `;
33
+
34
+ return (
35
+ <div>
36
+ <Markdown content={markdownContent} />
37
+ </div>
38
+ );
39
+ };
40
+
41
+ export default App;
42
+ ```
43
+
44
+ ## Props
45
+
46
+ | Prop | Type | Default | Description |
47
+ |------|------|---------|-------------|
48
+ | `content` | `string` | - | The markdown content to render |
49
+ | `className` | `string` | - | Additional CSS class names |
50
+
51
+ ## Features
52
+
53
+ - Renders headings using VaneUI `Title` component
54
+ - Renders paragraphs using VaneUI `Text` component
55
+ - Renders lists using VaneUI `List` and `ListItem` components
56
+ - Renders blockquotes using VaneUI `Card` component
57
+ - Renders horizontal rules using VaneUI `Divider` component
58
+ - Renders code blocks using VaneUI `Card` and `Text` components
59
+
60
+ ## Development
61
+
62
+ ```bash
63
+ # Install dependencies
64
+ npm install
65
+
66
+ # Run tests
67
+ npm test
68
+
69
+ # Build the package
70
+ npm run build
71
+ ```
@@ -0,0 +1,7 @@
1
+ import React from "react";
2
+ export declare const Md: React.FC<{
3
+ content: string;
4
+ frontmatter?: {
5
+ [key: string]: unknown;
6
+ };
7
+ }>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export { Md } from './components/md';