summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorAylur <[email protected]>2024-09-03 20:32:41 +0200
committerAylur <[email protected]>2024-09-03 20:32:41 +0200
commit6f39857dc7bf59d84c89b311690e858ce0a4724e (patch)
tree4ce9a79816a82de4778e068eadcdfb32b991df17 /docs/README.md
parentb8acc3897f5c48a5fc4ba73921c77cae2e91598c (diff)
docs: migrate to vitepress
vitepress feels a bit more polished and clean
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md11
1 files changed, 5 insertions, 6 deletions
diff --git a/docs/README.md b/docs/README.md
index 77144d5..6592cf4 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,8 +1,7 @@
# Astal Docs
-[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
-
-This directory contains the Astal documentation website. Hosted at [aylur.github.io/astal](https://aylur.github.io/astal/)
+This directory contains the Astal documentation and Library references.
+Hosted at [aylur.github.io/astal](https://aylur.github.io/astal/) and [aylur.github.io/libastal](https://aylur.github.io/libastal/)
## Commands
@@ -17,9 +16,9 @@ This directory contains the Astal documentation website. Hosted at [aylur.github
1. Add your image as a webp to `public/showcase`
2. Add it to `src/content/showcases.ts`
- - `src` should be `/astal/showcase/your-name-optional-title.webp`
- - `url` should point to the source code of the showcased widget
- - `author` your name
+ - `src` should be `/astal/showcase/your-name-optional-title.webp`
+ - `url` should point to the source code of the showcased widget
+ - `author` your name
```
.