Updated docz generator to use gatsby

Author: JohannesKlauss

.gitignore

@@ -5,6 +5,7 @@
 node_modules
 .cache
 dist
+public
 
 # Logs
 logs

README.md

@@ -52,7 +52,9 @@ section on the hotkeys documentation for more info.
 gets hit by the user. **Important:** Since version 1.5.0 this callback gets memoised inside the hook. So you don't have
 to do this anymore by yourself.
 - `options: Options = {}`
-  - `filter: (event: KeyboardEvent): boolean` is used to enable hotkeys inside input elements. Check out [hotkeys docs](https://github.com/jaywcjlove/hotkeys/#filter) for usage. Due to constraints with the base library, `filter` is a global setting. As a result, it is currently not possible to have different filters for separate calls of `useHotkey`.
+  - * `filter: (event: KeyboardEvent): boolean` is used to filter if a callback gets triggered depending on the keyboard event.
+    **Breaking Change in `3.0.0`!** Prior to version `3.0.0` the filter settings was one global setting that applied to every
+    hook. Since `3.0.0` this behavior changed. The `filter` option is now locally scoped to each call of `useHotkeys`.
   - * `enableOnTags: string[]` is used to enable listening to hotkeys in form fields. Available values are `INPUT`, `TEXTAREA` and `SELECT`. **IMPORTANT!** When you provide a custom `filter` implementation function this parameter will be ignored. Similar to `filter`, setting this option will enable it globally.
   - `splitKey: string` is used to change the splitting character inside the keys argument. Default is `+`, but if you want
     to listen to the `+` character, you can set `splitKey` to i.e. `-` and listen for `ctrl-+`

babel.config.json

@@ -0,0 +1,3 @@
+{
+  "plugins": ["@babel/plugin-proposal-class-properties"]
+}

docs/useHotkeys.mdx

@@ -68,9 +68,9 @@ The options parameter is used to pass options directly to the hotkeys package. C
 for an overview.
 
 ### Parameters
-* `filter: (event: KeyboardEvent): boolean` is used to enable hotkeys inside input elements. Check out
-[hotkeys docs](https://github.com/jaywcjlove/hotkeys/#filter) for usage. Due to constraints with the base library,
-`filter` is a global setting. As a result, it is currently not possible to have different filters for separate calls of `useHotkey`.
+* `filter: (event: KeyboardEvent): boolean` is used to filter if a callback gets triggered depending on the keyboard event.
+**Breaking Change in `3.0.0`!** Prior to version `3.0.0` the filter settings was one global setting that applied to every
+hook. Since `3.0.0` this behavior changed. The `filter` option is now locally scoped to each call of `useHotkeys`.
 * `enableOnTags: string[]` is used to enable listening to hotkeys in form fields. Available values are `INPUT`, `TEXTAREA`
 and `SELECT`.  Similar to `filter`, setting this option will enable it globally.
 **IMPORTANT!** When you provide a custom `filter` implementation function this parameter will be ignored.

doczrc.js

@@ -9,8 +9,6 @@ export default {
   hashRouter: true,
   typescript: true,
   themeConfig: {
-    colors: {
-      primary: '#000000',
-    },
+    initialColorMode: 'dark',
   },
 };

gatsby-config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  plugins: [
+    'gatsby-theme-docz',
+    `gatsby-transformer-sharp`,
+  ],
+}

package.json

@@ -28,8 +28,8 @@
     "build": "tsdx build",
     "test": "jest",
     "publish": "np",
-    "docz:dev": "docz dev",
-    "docz:build": "docz build"
+    "docz:dev": "gatsby develop",
+    "docz:build": "gatsby build"
   },
   "babel": {
     "presets": [
@@ -56,10 +56,10 @@
   },
   "devDependencies": {
     "@babel/core": "7.12.10",
+    "@babel/plugin-proposal-class-properties": "7.12.1",
     "@babel/preset-env": "7.12.11",
     "@babel/preset-react": "7.12.10",
     "@babel/preset-typescript": "7.12.7",
-    "@emotion/core": "11.0.0",
     "@testing-library/react": "11.2.2",
     "@testing-library/react-hooks": "3.4.2",
     "@types/jest": "26.0.19",
@@ -68,7 +68,10 @@
     "@types/testing-library__react": "10.0.1",
     "@types/testing-library__react-hooks": "3.4.1",
     "docz": "2.3.1",
-    "emotion-theming": "11.0.0",
+    "gatsby": "2.29.1",
+    "gatsby-plugin-sharp": "2.11.1",
+    "gatsby-theme-docz": "2.3.1",
+    "gatsby-transformer-sharp": "2.9.0",
     "eslint-plugin-prettier": "3.3.0",
     "gatsby-plugin-emotion": "5.1.0",
     "jest": "26.6.3",