Skip to content

Commit 34def1f

Browse files
committed
fix(docs): use proper page hyperlinks
1 parent a6fb2d8 commit 34def1f

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

docs/configuration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Configuring Mechvibes Lite
22
!!! important
33
Please ensure you have the software installed by following the
4-
instructions [here](/#installation).
4+
instructions [here](index.md#installation).
55

66
## Example Configuration File
77
```ini
@@ -65,7 +65,7 @@ information.
6565

6666
## In-depth Description
6767
To understand `wskey.*` options, it is recommended to refer to documentation
68-
available [here](/usage/#wskey).
68+
available [here](usage.md#wskey).
6969

7070
To undersand `wskey.event_id`, you should refer to documentation available
71-
[here](/installation/linux/#testing-access-for-input-event).
71+
[here](installation/linux.md#testing-access-for-input-event).

docs/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ made for the original version.
1010
welcome.
1111

1212
## Windows
13-
Please read the [installation page for Windows](/installation/windows).
13+
Please read the [installation page for Windows](installation/windows.md).
1414

1515
## Linux
16-
Please read the [installation page for Linux](/installation/linux).
16+
Please read the [installation page for Linux](installation/linux.md).
1717

1818
# Usage
1919
You can learn how to use this software [here](usage.md).

docs/installation/windows.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ Once you have Python installed, do this:
99
python -m pip install git+https://github.com/eeriemyxi/mechvibes-lite
1010
```
1111

12-
Now you can follow the usage guide of Mechvibes Lite [here](/#usage).
12+
Now you can follow the usage guide of Mechvibes Lite [here](../index.md/#usage).

docs/usage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This page is a guide to using Mechvibes Lite from the command-line.
33

44
!!! important
55
Please ensure you have the software installed by following the
6-
instructions [here](/#installation).
6+
instructions [here](index.md#installation).
77

88
## Running Mechvibes Lite
99
```shell
@@ -13,7 +13,7 @@ This will start Mechvibes Lite on your computer.
1313

1414
!!! important
1515
Please ensure you have a proper configuration file beforehand by
16-
following the instructions [here](#configuration).
16+
following the instructions [here](configuration.md).
1717

1818
!!! tip
1919
A [Wskey](#wskey) server is automatically ran in the background for you unless it
@@ -43,7 +43,7 @@ Windows it depends on `keyboard` package from the same repository.
4343
may be introduced in a future release.
4444

4545
The host address and the port is first fetched from `wskey` key in the
46-
configuration file. More information is available [here](#configuration).
46+
configuration file. More information is available [here](configuration.md).
4747
However the subcommand has a number of flags to override the configuration file:
4848

4949
```shell

0 commit comments

Comments
 (0)