Cleaned up get-started MD to pass simple linting

This commit is contained in:
Devin W. Leaman 2020-07-12 07:49:10 -05:00
parent 22648ebb45
commit daaf8527a4

View File

@ -13,13 +13,13 @@ espanso explicitly, such as when you're using Linux.
It's very easy to check if espanso is currently running: if you're using **MacOS** or **Windows**, you should see
the **icon in the status bar**. If you don't see it, or if you're using **Linux**, another way to check it is to **open a terminal** and type:
```
```bash
espanso status
```
If you see "`espanso is not running`", then you'll need to start espanso manually with the following command:
```
```bash
espanso start
```
@ -46,13 +46,14 @@ in two ways: creating your own **custom matches** or **installing packages**. Bo
espanso uses a **file-based configuration** approach, following the Unix philosophy. All configuration files
reside in the `espanso` directory, whose location depends on the current OS:
* Linux: `$XDG_CONFIG_HOME/espanso` (e.g. `/home/user/.config/espanso`)
* macOS: `$HOME/Library/Preferences/espanso` (e.g. `/Users/user/Library/Preferences/espanso`)
* Windows: `{FOLDERID_RoamingAppData}\espanso` (e.g. `C:\Users\user\AppData\Roaming\espanso`)
A quick way to find the path of your configuration folder is by using the following command:
```
```bash
espanso path
```
@ -70,7 +71,7 @@ tired of writing the greetings at the end, so you decide to speed up the process
We will configure espanso so that every time you type `:br`, it will be expanded to:
```
```bash
Best Regards,
Jon Snow
```
@ -97,10 +98,12 @@ matches:
```
We need to define a new Match, so in the `matches:` section, add the following code:
```yml
- trigger: ":br"
replace: "Best Regards,\nJon Snow"
```
**Make sure to include the indentation**, otherwise it won't be valid YAML syntax. You should get something like:
```yml
@ -125,7 +128,7 @@ matches:
We're almost there! After every configuration change, **espanso must be restarted**. Open a terminal and type:
```
```bash
espanso restart
```
@ -150,13 +153,13 @@ Let's say you want to **add some emojis** to espanso, such that when you type `:
A solution would be to install the [Basic Emojis](https://hub.espanso.org/packages/basic-emojis/) package from the
[espanso hub](https://hub.espanso.org/) store. Open a terminal and type:
```
```bash
espanso install basic-emojis
```
At this point, as we did with custom matches, we need to **restart espanso**. We can do so with the command:
```
```bash
espanso restart
```
@ -172,4 +175,3 @@ easily accomplished by quickly **double pressing the `ALT` key** ( Option on Mac
At this point, espanso will be disabled and will not expand any match.
To **re-enable** it, double press the `ALT` key again.