fixup: Apply Markdown linting

OpenTabletDriver · Dec 2, 2023 · 0263944 · 0263944
1 parent 1c3ec38
commit 0263944
Show file tree

Hide file tree

Showing 10 changed files with 111 additions and 107 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # [opentabletdriver.github.io](https://opentabletdriver.github.io)
-*The next version of OpenTabletDriver.Web*
+
+The next version of OpenTabletDriver.Web
 
 ## Local Development
 
@@ -10,15 +11,15 @@
 ## Steps
 
 ```bash
-$ gem install jekyll bundler
-$ cd <website root> # (currently git root)
-$ git submodule init # submodules contain plugin data
-$ git submodule update
-$ bundle install
-$ bundle exec jekyll serve --livereload
+gem install jekyll bundler
+cd <website root> # (currently git root)
+git submodule init # submodules contain plugin data
+git submodule update
+bundle install
+bundle exec jekyll serve --livereload
 ```
 
-# FAQ
+## FAQ
 
 ### **How do I add a wiki entry?**
 

diff --git a/TODO.md b/TODO.md
@@ -1,4 +1,6 @@
-# Roadmap (rough order)
+# TODO
+
+## Roadmap (rough order)
 
 - [x] Tablets
 - [x] GitHub link
@@ -18,7 +20,6 @@
 - [ ] Move DNS
 - [ ] Close OpenTabletDriver.Web
 
-# Other stuff:
+## Other stuff
 
 - [ ] Bus factor
-
diff --git a/site/_wiki/Documentation/RequiredPermissions.md b/site/_wiki/Documentation/RequiredPermissions.md
@@ -37,7 +37,7 @@ latest version, refer to the instructions below depending on if you installed Op
 - [Package manager](#package-manager), or
 - [Built from source](#built-from-source)
 
-However if you're using a version of OpenTabletDriver _below_ **0.6.3.0** and somehow cannot update
+However if you're using a version of OpenTabletDriver *below* **0.6.3.0** and somehow cannot update
 to the latest version, refer to the [Legacy package](#legacy-package) section.
 
 ### Package manager
@@ -134,7 +134,7 @@ Refer to your distro's documentation on how to remove udev rules of the name
 `90-opentabletdriver.rules` or `99-opentabletdriver.rules` and a kernel module blacklist named
 `blacklist.conf` containing:
 
-```
+```conf
 blacklist wacom
 blacklist hid_uclogic
 ```

diff --git a/site/_wiki/FAQ/General.md b/site/_wiki/FAQ/General.md
@@ -12,7 +12,7 @@ Verify if your tablet is in the list of supported tablets [here]({% link _sectio
 
 ### My tablet is supported but not detected? {#tablet-not-detected}
 
-OpenTabletDriver currently has _no support_ for tablets connected via Bluetooth. Make sure that your tablet is connected via USB. There is partial support for tablets connected via wireless dongle.
+OpenTabletDriver currently has *no support* for tablets connected via Bluetooth. Make sure that your tablet is connected via USB. There is partial support for tablets connected via wireless dongle.
 
 Once plugged in, determine if your tablet has good connection to the computer:
 
@@ -102,7 +102,7 @@ Uninstall any other tablet drivers you have installed.
 
 Use the following formulas to get values for the area editor's `Width`, `Height`, `XOffset`, and `YOffset` fields.
 
-**Wacom and Veikk**
+##### Wacom and Veikk
 
 | Term | Definition |
 | --- | --- |
@@ -113,14 +113,14 @@ Use the following formulas to get values for the area editor's `Width`, `Height`
 
 Formula:
 
-```
+```py
 Width = (Right - Left) / LPI * 25.4
 Height = (Bottom - Top) / LPI * 25.4
 XOffset = (Left / LPI * 25.4) + (Width / 2)
 YOffset = (Top / LPI * 25.4) + (Height / 2)
 ```
 
-**XP-Pen**
+##### XP-Pen
 
 | Term | Definition |
 | --- | --- |
@@ -131,14 +131,14 @@ YOffset = (Top / LPI * 25.4) + (Height / 2)
 
 Formula:
 
-```
+```py
 Width = XPW / 3.937
 Height = XPH / 3.937
 XOffset = (Width / 2) + (XPX / 3.937)
 YOffset = (Height / 2) + (XPY / 3.937)
 ```
 
-**Huion and Gaomon**
+##### Huion and Gaomon
 
 | Term | Definition |
 | --- | --- |
@@ -149,7 +149,7 @@ YOffset = (Height / 2) + (XPY / 3.937)
 
 Formula:
 
-```
+```py
 Width = (Right - Left) * TWidth
 Height = (Bottom - Top) * THeight
 XOffset = (Width / 2) + (Left * TWidth)

diff --git a/site/_wiki/FAQ/Linux.md b/site/_wiki/FAQ/Linux.md
@@ -17,25 +17,21 @@ If your tablet is connected properly and is supported, but is still not detected
 
 ##### Another driver is found {#hid_uclogic}
 
-_Symptoms_
+*Symptoms*:
 
-```
-Another tablet driver found: <driver>
-```
+> Another tablet driver found: &lt;driver&gt;
 
-_Solution_
+*Solution*:
 
 - [See here]({% link _wiki/Documentation/RequiredPermissions.md %}#setup-linux)
 
 ##### Insufficient permissions {#udev}
 
-_Symptoms_
+*Symptoms*:
 
-```
-Not permitted to open HID class device at /dev/hidrawX
-```
+> Not permitted to open HID class device at /dev/hidrawX
 
-_Solution_
+*Solution*:
 
 - [See here]({% link _wiki/Documentation/RequiredPermissions.md %})
 
@@ -47,37 +43,28 @@ If this is a fresh install and you have not configured your tablet yet, [check l
 
 ##### Missing uinput device
 
-_Symptoms_
+*Symptoms*:
 
-```
-Failed to initialize virtual tablet. (error code ENODEV)
-```
+> Failed to initialize virtual tablet. (error code ENODEV)
 
-_Solution_
+*Solution*:
 
 - Reboot your computer.
 
 ##### Missing uinput device support
 
-_Symptoms_
+*Symptoms*:
 
-```
-Failed to initialize virtual tablet. (error code ENOENT)
-```
-
-_Solution_
+> Failed to initialize virtual tablet. (error code ENOENT)
 
-- Make sure that your kernel has uinput support. If you are using a custom kernel or builds kernel from source, make sure that you have enabled `CONFIG_INPUT_UINPUT` in your kernel configuration. Refer to your distro's documentation regarding kernel configuration.
+Make sure that your kernel has uinput support. If you are using a custom kernel or builds kernel from source, make sure that you have enabled `CONFIG_INPUT_UINPUT` in your kernel configuration. Refer to your distro's documentation regarding kernel configuration.
 
 ##### Missing uinput device permissions
 
-_Symptoms_
-
-```
-Failed to initialize virtual tablet. (error code EACCES)
-```
+Symptoms:
+> Failed to initialize virtual tablet. (error code EACCES)
 
-_Solution_
+###### Solution
 
 - [See here]({% link _wiki/Documentation/RequiredPermissions.md %})
 

diff --git a/site/_wiki/FAQ/Windows.md b/site/_wiki/FAQ/Windows.md
@@ -7,7 +7,6 @@ hide_from_auto_list: true
 first before continuing.**
 - Also check out [Windows App Specific FAQ]({% link _wiki/FAQ/WindowsAppSpecific.md %}) for app-specific instructions.
 
-
 ### My tablet is supported but not detected? {#troubleshooting}
 
 Read [General]({% link _wiki/FAQ/General.md %}#tablet-not-detected) first before continuing below if you haven't already.
@@ -26,27 +25,23 @@ Please check if your tablet requires WinUSB [here]({% link _sections/Tablets.md
 
 ##### Tablet driver interference
 
-_Symptoms_
+*Symptoms*:
 
-```
-Another tablet driver found: <driver>
-```
+> Another tablet driver found: &lt;driver&gt;
 
-_Solution_
+*Solution*:
 
-- Follow the instructions in [TabletDriverCleanup](https://github.com/X9VoiD/TabletDriverCleanup/releases/latest), and make sure to type `y` for every driver found by the utility. Then, restart OTD.
+- Follow the instructions in [TabletDriverCleanup](https://github.com/X9VoiD/TabletDriverCleanup/releases/latest), and make sure to type <kbd>Y</kbd> for every driver found by the utility. Then, restart OTD.
 - If the log entry is still present, try joining our support [Discord]({{ site.discord_invite_url }}) and asking for help in one of the #support channels.
 
 ##### Invalid WinUSB driver state
 
-_Symptoms_
+*Symptoms*:
 
-```sh
-Failed to open file handle to WinUSB interface
-SafeHandle cannot be null. (Parameter 'pHandle')
-```
+> Failed to open file handle to WinUSB interface\
+> SafeHandle cannot be null. (Parameter 'pHandle')
 
-_Solution_
+*Solution*:
 
 - Restart your computer.
 

diff --git a/site/_wiki/FAQ/WindowsAppSpecific.md b/site/_wiki/FAQ/WindowsAppSpecific.md
@@ -20,7 +20,7 @@ See [above](#raw-input).
 
 Do not use Windows Ink.
 
-#### My cursor is shaky!
+#### My cursor is shaky
 
 That's perfectly normal unless it's going really crazy and teleports everywhere. In that case, see this section about resolving [EMI issues]({% link _wiki/FAQ/General.md %}#emi-interference).