Switch theme to Doks

content/docs/kbdemu/_index.md

@@ -0,0 +1,8 @@
+---
+title: "KbdEmu Docs"
+draft: true
+description: "Documentation for KbdEmu, the HID emulator"
+menu:
+    docs:
+        parent: "docs"
+---

content/docs/kbdemu/installation.md

@@ -0,0 +1,70 @@
+---
+title: "Installation"
+draft: false
+description: "Installing kbdemu"
+---
+{{< appveyor-ci project="kbdemu" projectID="km2f1wiy7enuh6il" >}}
+{{< minio-s3 project="kbdemu" >}}
+
+## Using precompiled binary
+KbdEmu uses continuous integration to compile. You can find the binary by
+clicking the CI badge above, selecting "Ubuntu2004" for the linux build or
+"macOS" for the macOS build, and then going to the artifacts tab.
+
+## Building from source
+
+### Downloading
+KbdEmu is hosted in two places, Gitea and Gitlab. Either one can be used as
+it is mirrored from Gitea to Gitlab
+
+{{< button-gitea color="green" project="kbdemu" text="KbdEmu" >}}
+{{< button-gitlab color="OrangeRed" project="kbdemu" text="KbdEmu" >}}
+
+To download kbdemu, you can either use the download button on one of the above, or
+you can use the git command
+
+To clone kbdemu using the command, run one of the following commands:
+```bash
+git clone https://gitea.arsenm.dev/Arsen6331/kbdemu
+OR
+git clone https://gitlab.com/moussaelianarsen/kbdemu
+```
+
+Now, you will want to `cd` into the root of this repo before completing the rest
+of these instructions
+
+### Building
+
+Since KbdEmu is written in go, you will need go installed in order to compile it.
+Most linux distros call the package providing it either `go` or `golang`.
+
+Once go is installed, you can check that it runs by running
+```bash
+go version
+```
+To compile KbdEmu, run the following commands:
+```bash
+go get github.com/go-vgo/robotgo
+go get github.com/BurntSushi/toml
+go get github.com/rs/zerolog/log
+source .envrc
+go build
+```
+
+### Installing
+
+To install kbdemu, run the following command:
+
+```bash
+sudo install -Dm755 kbdemu /usr/bin
+```
+
+Once this command completes, to test whether kbdemu was installed properly, run
+this command:
+
+```bash
+kbdemu
+```
+
+You should get an error warning you that kbdemu cannot find a TOML file. If you do,
+kbdemu is properly installed.

content/docs/kbdemu/usage.md

@@ -0,0 +1,69 @@
+---
+title: "Usage"
+draft: false
+description: "Using kbdemu"
+---
+{{< appveyor-ci project="kbdemu" projectID="km2f1wiy7enuh6il" >}}
+{{< minio-s3 project="kbdemu" >}}
+
+This page assumes you have already installed KbdEmu. If not, follow the installation
+instructions on the installation page.
+
+{{< button text="Installation" link="../installation" color="blue">}}
+
+### Configs
+
+KbdEmu uses TOML configs to tell it what to do. This is the example config which
+contains all supported features:
+
+```toml
+[[action]]
+type = "var"
+action = "set key to z"
+
+ [[action]]
+type = "kbd"
+action = "hold key @key@"
+
+ [[action]]
+type = "misc"
+action = "wait 1 second"
+
+ [[action]]
+type = "kbd"
+action = "release key @key@"
+
+ [[action]]
+type = "kbd"
+action = "press space"
+
+ [[action]]
+type = "kbd"
+action = "type AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz"
+
+ [[action]]
+type = "mse"
+action = "scroll up 5"
+
+ [[action]]
+type = "mse"
+action= "right click"
+
+ [[action]]
+type = "mse"
+action = "move to {0,0}"
+
+ [[action]]
+type = "misc"
+action = "show message Actions complete!"
+```
+
+As you can see, the configs are pretty simple. Here is a list of all the currently
+supported features:
+{{<table "f6 w-100 mw8 center">}}
+| Var Type          | Misc Type         | Kbd Type     | Mse Type       |
+|-------------------|-------------------|--------------|----------------|
+| Setting Variables | Delays            | Hold Keys    | Scrolling      |
+|                   | Showing Messages  | Release Keys | Mouse Clicks   |
+|                   |                   | Type Strings | Mouse Movement |
+{{</table>}}