feat: docs website (#80)

Deploy the documentation to GitHub Pages using `mdbook` and a little
more content for it. Can be visited at https://apricote.github.io/hcloud-upload-image.
This commit is contained in:
Julian Tölle 2025-05-04 02:18:47 +02:00 committed by GitHub
parent c175ca0352
commit d144b85e3d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 118 additions and 3 deletions

View file

@ -1,6 +1,15 @@
# `hcloud-upload-image`
Quickly upload any raw disk images into your [Hetzner Cloud](https://hetzner.com/cloud) projects!
<p align="center">
Quickly upload any raw disk images into your <a href="https://hetzner.com/cloud" target="_blank">Hetzner Cloud</a> projects!
</p>
<p align="center">
<a href="https://apricote.github.io/hcloud-upload-image" target="_blank"><img src="https://img.shields.io/badge/Documentation-brightgreen?style=flat-square" alt="Badge: Documentation"/></a>
<a href="https://github.com/apricote/hcloud-upload-image/releases" target="_blank"><img src="https://img.shields.io/github/v/release/apricote/hcloud-upload-image?sort=semver&display_name=release&style=flat-square&color=green" alt="Badge: Stable Release"/></a>
<img src="https://img.shields.io/badge/License-MIT-green?style=flat-square" alt="Badge: License MIT"/>
</p>
## About
@ -63,7 +72,7 @@ hcloud-upload-image upload \
--compression bz2
```
To learn more, you can use the embedded help output or check out the [CLI help pages in this repository](docs/cli/hcloud-upload-image.md).:
To learn more, you can use the embedded help output or check out the [CLI help pages in this repository](docs/reference/cli/hcloud-upload-image.md).:
```shell
hcloud-upload-image --help