Docs

devhttps · Nov 12, 2018 · a621f1b · a621f1b
1 parent a374ada
commit a621f1b
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 
 <br />
 
-Retoggle is a collection of React hooks which provides UI toggles to manipulate your component state from outside. Like [Storybook Knobs](https://www.npmjs.com/package/@storybook/addon-knobs) but with React hooks and also without Storybook. This library is inspired by [ideas from Dan Abramov](https://twitter.com/dan_abramov/status/1058834904207761409).
+Retoggle is a collection of React hooks which provides UI toggles to manipulate your component state from outside. Like [Storybook Knobs](https://www.npmjs.com/package/@storybook/addon-knobs). This library is inspired by [ideas from Dan Abramov](https://twitter.com/dan_abramov/status/1058834904207761409).
 
 - 🎉 A wide range of toggles
 - 💡 Frictionless integration

diff --git a/docs/a-inspector/b-themeInspector.mdx b/docs/a-inspector/b-themeInspector.mdx
@@ -13,30 +13,31 @@ The inspector and the controls can be themed by passing an object as shown below
 
 ```javascript
 const CustomTheme = {
-  primaryColor: "string",
-  backgroundColor: "string",
+  primaryColor: string;
+  backgroundColor: string;
   collapseHandle: {
-    backgroundColor: "string"
-  },
+    backgroundColor: string;
+    color: string;
+  };
   knob: {
     label: {
-      color: "string",
-      dividerColor: "string"
-    },
+      color: string;
+      dividerColor: string;
+    };
     slider: {
-      railColor: "string",
-      handleColor: "string",
-      activeTrackColor: "string"
-    }
-  },
+      railColor: string;
+      handleColor: string;
+      activeTrackColor: string;
+    };
+  };
   log: {
-    objectViewerTheme: "string",
+    objectViewerTheme: string;
     label: {
-      color: "string",
-      dividerColor: "string"
-    }
-  }
-};
+      color: string;
+      dividerColor: string;
+    };
+  };
+}
 ```
 
 #### In-built dark theme

diff --git a/docs/c-knobs/j-customKnob.mdx b/docs/c-knobs/j-customKnob.mdx
@@ -114,7 +114,7 @@ export default function useChartKnob(name: string, value: any) {
 }
 ```
 
-## Helper KnobFrame component
+## Helper KnobFrame Component
 
 Retoggle provides a helper `KnobFrame` component you can use with your custom knobs. The frame providers a label and a placeholder for icon.
-Original file line number
+Diff line change
@@ Expand Up @@
     }
     ```
-    ## Helper KnobFrame component
+    ## Helper KnobFrame Component
     Retoggle provides a helper `KnobFrame` component you can use with your custom knobs. The frame providers a label and a placeholder for icon.
@@ Expand Down @@