react-native-marked 2.0.0-rc.0 → 2.0.0

package/README.md

@@ -38,7 +38,6 @@ export default ExampleComponent;
 ## Examples
 
 - RN App: https://github.com/gmsgowtham/react-native-marked-test
-- Snack: https://snack.expo.dev/@gmsgowtham/react-native-marked
 
 ## [Props](https://github.com/gmsgowtham/react-native-marked/blob/main/src/lib/types.ts#L9)
 
@@ -122,6 +121,54 @@ const ExampleComponent = () => {
 export default ExampleComponent;
 ```
 
+> Please refer to `RendererInterface` for all the override methods
+
+```ts
+export interface RendererInterface {
+  paragraph(children: ReactNode[], styles?: ViewStyle): ReactNode;
+  blockquote(children: ReactNode[], styles?: ViewStyle): ReactNode;
+  heading(text: string | ReactNode[], styles?: TextStyle): ReactNode;
+  code(
+    text: string,
+    language?: string,
+    containerStyle?: ViewStyle,
+    textStyle?: TextStyle,
+  ): ReactNode;
+  hr(styles?: ViewStyle): ReactNode;
+  listItem(children: ReactNode[], styles?: ViewStyle): ReactNode;
+  list(
+    ordered: boolean,
+    li: ReactNode[],
+    listStyle?: ViewStyle,
+    textStyle?: TextStyle,
+  ): ReactNode;
+  escape(text: string, styles?: TextStyle): ReactNode;
+  link(
+    children: string | ReactNode[],
+    href: string,
+    styles?: TextStyle,
+  ): ReactNode;
+  image(uri: string, alt?: string, style?: ImageStyle): ReactNode;
+  strong(children: ReactNode[], styles?: TextStyle): ReactNode;
+  em(children: ReactNode[], styles?: TextStyle): ReactNode;
+  codespan(text: string, styles?: TextStyle): ReactNode;
+  br(): ReactNode;
+  del(children: ReactNode[], styles?: TextStyle): ReactNode;
+  text(text: string | ReactNode[], styles?: TextStyle): ReactNode;
+  html(text: string | ReactNode[], styles?: TextStyle): ReactNode;
+  linkImage(
+    href: string,
+    imageUrl: string,
+    alt?: string,
+    style?: ImageStyle,
+  ): ReactNode;
+}
+```
+
+> Note:
+>
+> For `key` property for a component, use `getKey` method from Renderer class.
+
 ## Screenshots
 
 |                          Dark Theme                           |                           Light Theme                            |

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "react-native-marked",
-  "version": "2.0.0-rc.0",
+  "version": "2.0.0",
   "description": "Markdown renderer for React Native powered by marked.js",
   "main": "dist/commonjs/index",
   "module": "dist/module/index",
-  "types": "dist/typescript/src/index.d.ts",
+  "types": "dist/typescript/index.d.ts",
   "react-native": "src/index",
   "source": "src/index",
   "files": [