Merge pull request #4381 from mark2185/master

Update docs
This commit is contained in:
Oliver Blanthorn 2022-09-06 13:20:59 +02:00 committed by GitHub
commit 355b47cc33
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 12 additions and 11 deletions

View file

@ -16,4 +16,5 @@ do
sed "/REPLACETHIS/,$ d" tutor.template.html > "$dest$fileroot.html"
"$(yarn bin)/marked" "$page" >> "$dest$fileroot.html"
sed "1,/REPLACETHIS/ d" tutor.template.html >> "$dest$fileroot.html"
sed -i "s|\.md|.html|g" "$dest$fileroot.html"
done

View file

@ -39,4 +39,4 @@ Almost all of the modes are controlled by series of keypresses. In this tutorial
## Normal mode
The tutorial for normal mode starts on the [next page](./2-normal_mode.html). You could try following the link by using hint mode: press `f` (if there is only a single link on the screen, it will be followed; otherwise type the characters that appear above the desired link, in lower case. They are only displayed in upper case for ease of reading).
The tutorial for normal mode starts on the [next page](./2-normal_mode.md). You could try following the link by using hint mode: press `f` (if there is only a single link on the screen, it will be followed; otherwise type the characters that appear above the desired link, in lower case. They are only displayed in upper case for ease of reading).

View file

@ -43,6 +43,6 @@ Unbind the binds with `unbind --mode=browser [key]`.
---
The [next page](./3-hint_mode.html) will explain how to use some of the various hint modes. This time try `]]` (guess the next page) to follow the link.
The [next page](./3-hint_mode.md) will explain how to use some of the various hint modes. This time try `]]` (guess the next page) to follow the link.
<a href='./1-tutor.html' rel="prev"></a>
<a href='./1-tutor.md' rel="prev"></a>

View file

@ -22,4 +22,4 @@ The visual mode keybinds:
See ":help vmaps" to see all the binds.
The [next page](./4-command_mode.html) will cover the command mode. <a href='./3-hint_mode.html' rel="prev"></a>
The [next page](./4-command_mode.md) will cover the command mode. <a href='./3-hint_mode.md' rel="prev"></a>

View file

@ -15,4 +15,4 @@ If there is ever only a single hint remaining (for example, because you have wit
Some hints have their tags (the labels which show which characters to press to activate them) in grey in the default theme. These correspond to elements which have JavaScript mouse events attached to them. If an element has a grey and a red hint tag next to it, pick the red one as this is almost always the correct tag.
The [next page](./3-1-visual_mode.html) will cover the visual mode. <a href='./2-normal_mode.html' rel="prev"></a>
The [next page](./3-1-visual_mode.md) will cover the visual mode. <a href='./2-normal_mode.md' rel="prev"></a>

View file

@ -20,4 +20,4 @@ We support a handful of keybinds in the console:
- `Ctrl-Enter` to execute the highlighted completion and keep the command line open
- `<C-o>yy` to copy the highlighted completion to your clipboard
The [next page](./5-settings.html) will talk about the various settings available. <a href='./3-1-visual_mode.html' rel="prev"></a>
The [next page](./5-settings.md) will talk about the various settings available. <a href='./3-1-visual_mode.md' rel="prev"></a>

View file

@ -24,4 +24,4 @@ There are many other commands related to settings:
- `:unbind` unbinds a key sequence
- `:setnull` deletes a setting (overwriting the default with an "empty" setting - useful for deleting searchurls, for example)
The [next page](./6-containers.html) will talk about how to operate firefox containers with tridactyl. <a href='./4-command_mode.html' rel="prev"></a>
The [next page](./6-containers.md) will talk about how to operate firefox containers with tridactyl. <a href='./4-command_mode.md' rel="prev"></a>

View file

@ -15,4 +15,4 @@ The perceived benefits of this feature are as described by the Firefox Test Pilo
* `tabopen -c name [url]` Opens a new tab in the container called `name`
* `winopen -c name [url]` Opens a new window in the container called `name`
The <a href='./7-native_messenger.html' rel='next'>next page</a> is about the native messenger. <a href='./5-settings.html' rel="prev"></a>
The <a href='./7-native_messenger.md' rel='next'>next page</a> is about the native messenger. <a href='./5-settings.md' rel="prev"></a>

View file

@ -16,4 +16,4 @@ The native messenger is an external executable that you can install on your comp
If these seem like interesting features to you, you can run `:nativeinstall` and follow the instructions in order to install the native messenger. If everything went smoothly, running `:native` should tell you that the native messenger is correctly installed.
The <a href='./8-marks.html' rel='next'>next page</a> explains how to use marks to move to a previously recorded position. <a href='./6-containers.html' rel="prev"></a>
The <a href='./8-marks.md' rel='next'>next page</a> explains how to use marks to move to a previously recorded position. <a href='./6-containers.md' rel="prev"></a>

View file

@ -12,4 +12,4 @@ You can add a mark with `markadd [key]` or by using the default keybinding `m[ke
Try marking this position using `mA`. Switch to another tab and press `` `A `` to come back here. Press ` `` ` to go back to where you came from. You can also try setting a local mark using `ma` in the middle of a scrollable page, press `gg` to move to the top and then press `` `a `` to jump to the mark.
The [next and final page](./9-help.html) of this tutorial is about getting help. <a href='./7-native_messenger.html' rel="prev"></a>
The [next and final page](./9-help.md) of this tutorial is about getting help. <a href='./7-native_messenger.md' rel="prev"></a>

View file

@ -12,4 +12,4 @@ If Tridactyl doesn't work or breaks pages we have a [troubleshooting guide](http
Lastly, you can contact the developers via Matrix or GitHub, as mentioned on the new tab page.
This concludes the tutorial. If you have any feedback, please leave it on [the relevant GitHub issue](https://github.com/tridactyl/tridactyl/issues/380). <a href='./8-marks.html' rel="prev"></a>
This concludes the tutorial. If you have any feedback, please leave it on [the relevant GitHub issue](https://github.com/tridactyl/tridactyl/issues/380). <a href='./8-marks.md' rel="prev"></a>