feat: Update readme

README.md

@@ -46,7 +46,7 @@ Props available for `MuiMarkdown` component:
 | prismTheme        | PrismTheme              | vsDark           | **optional**          |
 | Highlight         | HighlightComponent      | -                | **optional**          |
 | themes            | HighlightThemes         | -                | **optional**          |
-| showLineNumbers   | boolean                 | true             | **optional**          |
+| hideLineNumbers   | boolean                 | false            | **optional**          |
 
 Note: You cannot use overrides and options at the same time.
 
@@ -93,7 +93,7 @@ const App = () => {
   return (
     <MuiMarkdown
       overrides={{
-        ...getOverrides({}), // This will keep the other default overrides.
+        ...getOverrides(), // This will keep the other default overrides.
         h1: {
           component: 'p',
           props: {
@@ -123,7 +123,7 @@ const App = () => {
   return (
     <MuiMarkdown
       overrides={{
-        ...getOverrides({}), // This will keep the other default overrides.
+        ...getOverrides(), // This will keep the other default overrides.
         h1: {
           component: CustomTypography,
           props: {
@@ -153,43 +153,7 @@ const App = () => {
   return (
     <MuiMarkdown
       overrides={{
-        ...getOverrides({}), // This will keep the other default overrides.
-        h1: {
-          component: CustomTypography,
-          props: {
-            // custom props
-          } as CustomTypographyProps,
-        },
-      }}
-    >
-      {`# Hello markdown!`}
-    </MuiMarkdown>
-  );
-};
-
-export default App;
-```
-
-**An example of override that further customizes code blocks:**
-
-TS and TSX:
-
-```tsx
-import React from 'react';
-import { MuiMarkdown, getOverrides } from 'mui-markdown';
-import { Highlight, themes, Prism } from 'prism-react-renderer';
-import CustomTypography, {
-  CustomTypographyProps,
-} from './components/CustomTypography';
-
-(typeof global !== "undefined" ? global : window).Prism = Prism
-require("prismjs/components/prism-python")
-
-const App = () => {
-  return (
-    <MuiMarkdown
-      overrides={{
-        ...getOverrides({ Highlight, themes, theme: themes.vsDark, showLineNumbers: false })
+        ...getOverrides(), // This will keep the other default overrides.
         h1: {
           component: CustomTypography,
           props: {
@@ -251,7 +215,9 @@ const App = () => {
       Highlight={Highlight}
       themes={themes}
       prismTheme={themes.github}
-    >{`# Hello markdown!`}</MuiMarkdown>
+    >
+      {`# Hello markdown!`}
+    </MuiMarkdown>
   );
 };
 
@@ -271,7 +237,32 @@ const App = () => {
       Highlight={Highlight}
       themes={themes}
       prismTheme={themes.github}
-    >{`# Hello markdown!`}</MuiMarkdown>
+    >
+      {`# Hello markdown!`}
+    </MuiMarkdown>
+  );
+};
+
+export default App;
+```
+
+Also to disable the line numbers in the code block you can use the `hideLineNumbers`.
+
+```tsx
+import React from 'react';
+import { MuiMarkdown } from 'mui-markdown';
+import { Highlight, themes } from 'prism-react-renderer';
+
+const App = () => {
+  return (
+    <MuiMarkdown
+      Highlight={Highlight}
+      themes={themes}
+      prismTheme={themes.github}
+      hideLineNumbers
+    >
+      {`# Hello markdown!`}
+    </MuiMarkdown>
   );
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mui-markdown",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "private": false,
   "author": {
     "name": "Hosein Pouyanmehr",