Improve documentation
This commit is contained in:
parent
e02fe5c7b5
commit
c7224ac78e
|
@ -1,6 +1,15 @@
|
||||||
- name: Installation
|
- name: Installation
|
||||||
link: /install/
|
link: /install/
|
||||||
desc: This section will cover the installation process on Windows, macOS and Linux.
|
desc: This section will cover the installation process on Windows, macOS and Linux.
|
||||||
- name: Basic Usage
|
- name: Getting Started
|
||||||
link: /docs/basic-usage/
|
link: /docs/get-started/
|
||||||
desc: In this section we will cover the basics of espanso to get you started immediately.
|
desc: In this section we will cover the basics of espanso to get you started immediately.
|
||||||
|
- name: Matches
|
||||||
|
link: /docs/matches/
|
||||||
|
desc: This sections will cover Matches in detail, showing their features and options.
|
||||||
|
- name: Packages
|
||||||
|
link: /docs/packages/
|
||||||
|
desc: This section will cover the basics and the creation of espanso packages.
|
||||||
|
- name: Configuration
|
||||||
|
link: /docs/configuration/
|
||||||
|
desc: This sections will cover the configuration options and behaviour.
|
BIN
assets/images/match1.png
Normal file
BIN
assets/images/match1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 26 KiB |
BIN
assets/images/match2.png
Normal file
BIN
assets/images/match2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 20 KiB |
|
@ -1,7 +0,0 @@
|
||||||
---
|
|
||||||
title: Basic Usage
|
|
||||||
layout: docs
|
|
||||||
---
|
|
||||||
In this section we will cover the basics of espanso to get you started immediately.
|
|
||||||
|
|
||||||
TODO
|
|
30
docs/configuration.md
Normal file
30
docs/configuration.md
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
---
|
||||||
|
title: Configuration
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
Following a Unix-like philisophy, **espanso uses files to manage it's configuration**
|
||||||
|
instead of GUIs. This has many advantages, such as the capability to easily sync your
|
||||||
|
configurations between machines using [Git](https://git-scm.com/) or cloud services
|
||||||
|
such as [Dropbox](https://www.dropbox.com/) or [Google Drive](https://www.google.com/drive/).
|
||||||
|
|
||||||
|
All espanso configurations reside in a folder called `.espanso`, located in the user home directory.
|
||||||
|
The path of the home directory depends on the Operating System, here's a few examples:
|
||||||
|
* Windows: `C:\Users\Federico\.espanso\`
|
||||||
|
* Mac: `/Users/Federico/.espanso/`
|
||||||
|
* Linux: `/home/federico/.espanso/`
|
||||||
|
|
||||||
|
After installing espanso, the `.espanso` directory will contain the following file structure:
|
||||||
|
|
||||||
|
```
|
||||||
|
- default.yml
|
||||||
|
- user/
|
||||||
|
- packages/
|
||||||
|
```
|
||||||
|
|
||||||
|
The `default.yml` file contains the **main configurations** and for a basic usage, this is the only file
|
||||||
|
you will be working with.
|
||||||
|
|
||||||
|
The `user` folder is used to store advanced configurations, such as [Application-specific](#application-specific-config) configs.
|
||||||
|
|
||||||
|
The `packages` folder stores packages installed using the *package manager* and should not be directly modified
|
||||||
|
by the user. For more information, check out the [Packages](/docs/packages) section of the documentation.
|
47
docs/get-started.md
Normal file
47
docs/get-started.md
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
---
|
||||||
|
title: Getting Started
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
In this section we will cover the basics of espanso to get you started immediately.
|
||||||
|
Make sure to [install espanso](/install) before diving into the next sections.
|
||||||
|
|
||||||
|
### Starting espanso
|
||||||
|
|
||||||
|
If you followed the [Windows](/install/win/) or [MacOS](/install/mac/) installation correctly, **espanso will be automatically started** when you power up your computer. There are times, however, when you may need to start
|
||||||
|
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:
|
||||||
|
|
||||||
|
```
|
||||||
|
espanso status
|
||||||
|
```
|
||||||
|
|
||||||
|
If you see "`espanso is not running`", then you'll need to start espanso manually with the following command:
|
||||||
|
|
||||||
|
```
|
||||||
|
espanso start
|
||||||
|
```
|
||||||
|
|
||||||
|
At this point you are ready to use espanso. Open any typing application and type `:espanso`, you should
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Understanding Matches
|
||||||
|
|
||||||
|
espanso works by **detecting** your keypresses and **replacing** them when they match a specific keyword, called *trigger*.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The rule that associate the *trigger* with the *replaced text* is called **Match** and is a core concept of espanso.
|
||||||
|
Matches are very flexible and powerful to solve many tasks. You can learn all about Matches in their [documentation](/docs/matches/) page.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
espanso ships with very few built-in Matches to give you the maximum flexibility, but you can expand it's capabilities
|
||||||
|
in two ways: creating your own **custom matches** or **installing packages**. Both of these possibilities are introduced below.
|
||||||
|
|
||||||
|
### Creating your own Match
|
||||||
|
|
||||||
|
### Installing a Package
|
7
docs/matches.md
Normal file
7
docs/matches.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Matches
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
This section will cover the basics of espanso packages and will show you how to create one.
|
||||||
|
|
||||||
|
TODO
|
7
docs/packages.md
Normal file
7
docs/packages.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Packages
|
||||||
|
layout: docs
|
||||||
|
---
|
||||||
|
This section will cover the basics of espanso packages and will show you how to create one.
|
||||||
|
|
||||||
|
TODO
|
Loading…
Reference in New Issue
Block a user