docs(mkdocs): start building dedicated site

This commit is contained in:
LGUG2Z
2024-01-12 18:40:58 -08:00
parent 57a3ba6d57
commit 6f08ec1cb3
7 changed files with 188 additions and 0 deletions

37
docs/getting-started.md Normal file
View File

@@ -0,0 +1,37 @@
---
hide:
- navigation
---
## Installation
Komorebi is available pre-built to install via
[Scoop](https://scoop.sh/#/apps?q=komorebi) and
[WinGet](https://winget.run/pkg/LGUG2Z/komorebi), and you may also built
it from [source](https://github.com/LGUG2Z/komorebi) if you would prefer.
- [Scoop](install/scoop.md)
- [WinGet](install/winget.md)
- [Build from source](install/source.md)
## Getting Example Configurations
Run the following command to download example configuration files for
`komorebi` and `whkd`. Pay attention to the output of the command to see
where the example files have been downloaded.
```powershell
komorebic quickstart
```
## Starting Komorebi
Run the following command to start `komorebi` and `whkd` with the example
configurations.
It is important that you run this command for the first time without
making any modifications to the example configurations to validate that
you have a working installation of both `komorebi` and `whkd`.
```powershell
komorebic start --whkd
```