feat: add docs

ubermanu · Apr 4, 2023 · 37d57a8 · 37d57a8
1 parent 0ccf801
commit 37d57a8
Show file tree

Hide file tree

Showing 3 changed files with 107 additions and 0 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,67 @@
+<center style="margin-bottom: 2em;">
+<img src="https://raw.githubusercontent.com/ubermanu/roller/main/src/images/roller-skate.svg" width="128" height="128" alt="Roller icon" />
+</center>
+
+**Roller** is an extension that allow auto scrolling of web pages, by pressing the **mouse wheel button**, on **Linux**.
+
+## Install
+
+You can download the extension from the [Chrome Web Store](https://chrome.google.com/webstore/detail/roller/kdcakfeidhfeilahlclgbnmpgebafjpm) or the [Firefox Add-ons Store](https://addons.mozilla.org/af/firefox/addon/roller-scroll/).
+
+> The extension is not available on the Microsoft Edge Add-ons Store, because Windows already supports auto scrolling.
+
+## Usage
+
+Press the mouse wheel button to start scrolling, and release it to stop scrolling.
+
+Check the options page to configure the scrolling speed, drag threshold, and more.
+
+## Options
+
+You can access the options page by clicking on the extension icon, and then clicking on the `Options` button.
+
+### Drag threshold
+
+The drag threshold is the minimum distance that the mouse must move before the scrolling starts.
+
+Default: `10`
+
+### Move Threshold
+
+The move threshold is the minimum distance that the mouse must move before the scrolling stops.
+
+Default: `10`
+
+### Move speed
+
+The move speed is the number of pixels that the page scrolls per second.
+
+Default: `10`
+
+### Sticky Scroll
+
+If sticky scroll is enabled, the page can be scrolled without holding the mouse wheel button.\
+Clicking on the page will start scrolling, and clicking again will stop scrolling.\
+This is similar to how the mouse wheel works on Windows.
+
+Default: `true`
+
+### Middle click
+
+If middle click is enabled, the middle mouse button will be used to start scrolling.
+
+Default: `true`
+
+### Ctrl + Left click
+
+If ctrl + left click is enabled, the left mouse button will be used to start scrolling, if the ctrl key is pressed.
+
+Default: `true`
+
+## License
+
+This project is licensed under the [MIT License](https://github.com/ubermanu/roller/blob/main/LICENSE).
+
+## Notes
+
+This is a fork of the original [AutoScroll](https://github.com/Pauan/AutoScroll) extension.
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Roller</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="description" content="Description" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0" />
+    <link rel="shortcut icon" href="https://raw.githubusercontent.com/ubermanu/roller/main/src/images/roller-skate.svg" type="image/svg+xml" />
+    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css" media="(prefers-color-scheme: light)" />
+    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css" media="(prefers-color-scheme: dark)" />
+    <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+    <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300&display=swap" rel="stylesheet" />
+    <style>
+      :root {
+        --theme-color: #226699;
+      }
+
+      @media (prefers-color-scheme: dark) {
+        :root {
+          --theme-color: #88c9f9;
+        }
+      }
+    </style>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script>
+      window.$docsify = {
+        name: 'Roller',
+        repo: 'https://github.com/ubermanu/roller',
+        hideSidebar: true,
+      }
+    </script>
+    <!-- Docsify v4 -->
+    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+    <script src="//cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
+  </body>
+</html>