open.source/espanso
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cleaned up get-started MD to pass simple linting

Browse Source
This commit is contained in:
Devin W. Leaman 2020-07-12 07:49:10 -05:00
parent 22648ebb45
commit daaf8527a4
1 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/get-started.md
View File

@ -13,18 +13,18 @@ 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 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: 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 espanso status
``` ```
If you see "`espanso is not running`", then you'll need to start espanso manually with the following command: If you see "`espanso is not running`", then you'll need to start espanso manually with the following command:
``` ```bash
espanso start espanso start
``` ```
At this point you are ready to use espanso. Open any typing application and type `:espanso`, you should At this point you are ready to use espanso. Open any typing application and type `:espanso`, you should
see `Hi there!` appear. see `Hi there!` appear.
If you don't see it, make sure espanso is currently running. You could also try to repeat the installation procedure. If you don't see it, make sure espanso is currently running. You could also try to repeat the installation procedure.
@ -46,21 +46,22 @@ 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 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: reside in the `espanso` directory, whose location depends on the current OS:
* Linux: `$XDG_CONFIG_HOME/espanso` (e.g. `/home/user/.config/espanso`) * Linux: `$XDG_CONFIG_HOME/espanso` (e.g. `/home/user/.config/espanso`)
* macOS: `$HOME/Library/Preferences/espanso` (e.g. `/Users/user/Library/Preferences/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`) * 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: A quick way to find the path of your configuration folder is by using the following command:
``` ```bash
espanso path espanso path
``` ```
While this folder may contain many different files, let's focus on the most important one: `default.yml`. While this folder may contain many different files, let's focus on the most important one: `default.yml`.
The `default.yml` file contain the **main espanso configuration** and uses the widely The `default.yml` file contain the **main espanso configuration** and uses the widely
spread [YAML](https://en.wikipedia.org/wiki/YAML) syntax. spread [YAML](https://en.wikipedia.org/wiki/YAML) syntax.
It can be used to change various settings as well as **creating custom matches**. It can be used to change various settings as well as **creating custom matches**.
You can learn all about espanso's configuration by visiting the [documentation](/docs/configuration). You can learn all about espanso's configuration by visiting the [documentation](/docs/configuration).
### Creating your own Match ### Creating your own Match
@ -70,12 +71,12 @@ 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: We will configure espanso so that every time you type `:br`, it will be expanded to:
``` ```bash
Best Regards, Best Regards,
Jon Snow Jon Snow
``` ```
By now you should know that we need to **define a Match**. By now you should know that we need to **define a Match**.
With your favourite text editor, open the `.espanso/default.yml` file, introduced previously in the [Configuration](#configuration) section. You should see something like: With your favourite text editor, open the `.espanso/default.yml` file, introduced previously in the [Configuration](#configuration) section. You should see something like:
@ -97,10 +98,12 @@ matches:
``` ```
We need to define a new Match, so in the `matches:` section, add the following code: We need to define a new Match, so in the `matches:` section, add the following code:
```yml ```yml
- trigger: ":br" - trigger: ":br"
replace: "Best Regards,\nJon Snow" replace: "Best Regards,\nJon Snow"
``` ```
**Make sure to include the indentation**, otherwise it won't be valid YAML syntax. You should get something like: **Make sure to include the indentation**, otherwise it won't be valid YAML syntax. You should get something like:
```yml ```yml
@ -125,20 +128,20 @@ matches:
We're almost there! After every configuration change, **espanso must be restarted**. Open a terminal and type: We're almost there! After every configuration change, **espanso must be restarted**. Open a terminal and type:
``` ```bash
espanso restart espanso restart
``` ```
Now try to type `:br` anywhere. If you did everything correctly, you should see `Best Regards` appear! Now try to type `:br` anywhere. If you did everything correctly, you should see `Best Regards` appear!
> In version 0.5.1, espanso introduced the `edit` subcommand which makes editing configuration files much easier. Take a look at [Quick Editing](/docs/configuration/#quick-editing) if you are interested. > In version 0.5.1, espanso introduced the `edit` subcommand which makes editing configuration files much easier. Take a look at [Quick Editing](/docs/configuration/#quick-editing) if you are interested.
### Understanding Packages ### Understanding Packages
Custom matches are amazing, but sometimes it can be tedious to define Matches for every **common operation**, Custom matches are amazing, but sometimes it can be tedious to define Matches for every **common operation**,
and even more when you want to **share them with other people**. and even more when you want to **share them with other people**.
espanso offers an easy way to **share and reuse matches** with other people, **packages**. In fact, they are so important that espanso includes a **build-in package manager** and a **store**, the [espanso hub](https://hub.espanso.org/). espanso offers an easy way to **share and reuse matches** with other people, **packages**. In fact, they are so important that espanso includes a **build-in package manager** and a **store**, the [espanso hub](https://hub.espanso.org/).
If you are lucky enough, someone might have already written a **package** to include the matches you need! If you are lucky enough, someone might have already written a **package** to include the matches you need!
Otherwise, you can create a package and publish it on the hub, for more information check out the [Packages](/docs/packages/) documentation. Otherwise, you can create a package and publish it on the hub, for more information check out the [Packages](/docs/packages/) documentation.
@ -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 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: [espanso hub](https://hub.espanso.org/) store. Open a terminal and type:
``` ```bash
espanso install basic-emojis 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: At this point, as we did with custom matches, we need to **restart espanso**. We can do so with the command:
``` ```bash
espanso restart espanso restart
``` ```
@ -169,7 +172,6 @@ Let's conclude this introduction with the most important shortcut espanso offers
There are times when you may want to **disable espanso to avoid an unwanted expansion**. This can be There are times when you may want to **disable espanso to avoid an unwanted expansion**. This can be
easily accomplished by quickly **double pressing the `ALT` key** ( Option on MacOS ). You should then see a notification showing "Espanso disabled". easily accomplished by quickly **double pressing the `ALT` key** ( Option on MacOS ). You should then see a notification showing "Espanso disabled".
At this point, espanso will be disabled and will not expand any match. At this point, espanso will be disabled and will not expand any match.
To **re-enable** it, double press the `ALT` key again. To **re-enable** it, double press the `ALT` key again.