@richmd/react 1.1.2 → 2.0.0-rc.0

package/README.md

@@ -112,8 +112,40 @@ export default function MarkdownEditor() {
 }
 ```
 
+### 4. Use the RichmdSlide component (optional)
+
+You can use the `RichmdSlide` component to create slide-style Markdown presentations. Here's an example:
+
+```tsx
+"use client";
+
+import { RichmdSlide } from "@richmd/react";
+
+export default function SlideShow() {
+  const markdownSlides = [
+    `# Slide 1
+Welcome to **RichmdSlide**!`,
+    `# Slide 2
+- Create slides easily
+- Supports Markdown syntax`,
+    `# Slide 3
+> "Markdown made interactive!"`,
+  ];
+
+  return (
+    <div className="slideshow-container">
+      <RichmdSlide text={markdownSlides.join("\n---\n")} isController={true} />
+    </div>
+  );
+}
+```
+
+In this example, `---` is used to separate slides. Setting the `isController` property to `true` enables the slide controller.
+
 ## Component API
 
+### `Richmd`
+
 The `Richmd` component accepts the following props:
 
 | Prop | Type | Required | Description |
@@ -122,6 +154,16 @@ The `Richmd` component accepts the following props:
 | `id` | string | No | HTML id attribute for the container div |
 | `className` | string | No | CSS class name for the container div |
 
+
+### `RichmdSlide`
+
+The `RichmdSlide` component accepts the following props:
+
+| Prop | Type | Required | Description |
+|------|------|----------|-------------|
+| `text` | string | Yes | The markdown text to render |
+| `isController` | boolean | Yes | Toggles the display of the slide controller |
+
 ## Supported Markdown Features
 
 Richmd supports a wide range of markdown features:
@@ -141,7 +183,8 @@ Richmd supports a wide range of markdown features:
 - Video (HTML5 video tag)
 - Custom HTML tags
 
-For detailed syntax documentation, refer to the [Richmd Markdown Syntax Documentation](https://github.com/richmd/core/blob/main/docs/md-syntax.md).
+For detailed syntax documentation, refer to the [Richmd Markdown Syntax Documentation](./docs/md-syntax.md).
+
 
 ## License
 

package/dist/Richmd.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Richmd.d.ts","sourceRoot":"","sources":["../src/Richmd.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAA;AAED,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAMxC,CAAC"}
+{"version":3,"file":"Richmd.d.ts","sourceRoot":"","sources":["../src/Richmd.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAA;AAED,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAQxC,CAAC"}

package/dist/RichmdSlide.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+type RichmdProps = {
+    text: string;
+    isController?: boolean;
+    id?: string;
+    className?: string;
+};
+export declare const RichmdSlide: React.FC<RichmdProps>;
+export {};
+//# sourceMappingURL=RichmdSlide.d.ts.map

package/dist/RichmdSlide.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RichmdSlide.d.ts","sourceRoot":"","sources":["../src/RichmdSlide.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAyC,MAAM,OAAO,CAAC;AAK9D,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAA;AAED,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAqE7C,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import "../styles/richmd.css";
 import { Richmd } from "./Richmd";
-export { Richmd };
+import { RichmdSlide } from "./RichmdSlide";
+export { Richmd, RichmdSlide };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC"}