diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/guide/ags/cli-app.md (renamed from docs/ags/cli-app.md) | 0 | ||||
| -rw-r--r-- | docs/guide/ags/faq.md (renamed from docs/ags/faq.md) | 2 | ||||
| -rw-r--r-- | docs/guide/ags/first-widgets.md (renamed from docs/ags/first-widgets.md) | 4 | ||||
| -rw-r--r-- | docs/guide/ags/installation.md (renamed from docs/ags/installation.md) | 0 | ||||
| -rw-r--r-- | docs/guide/ags/theming.md (renamed from docs/ags/theming.md) | 0 | ||||
| -rw-r--r-- | docs/guide/ags/utilities.md (renamed from docs/ags/utilities.md) | 0 | ||||
| -rw-r--r-- | docs/guide/ags/variable.md (renamed from docs/ags/variable.md) | 2 | ||||
| -rw-r--r-- | docs/guide/ags/widget.md (renamed from docs/ags/widget.md) | 0 | ||||
| -rw-r--r-- | docs/guide/getting-started/installation.md (renamed from docs/getting-started/installation.md) | 0 | ||||
| -rw-r--r-- | docs/guide/getting-started/introduction.md (renamed from docs/getting-started/introduction.md) | 2 | ||||
| -rw-r--r-- | docs/guide/getting-started/nix.md (renamed from docs/getting-started/nix.md) | 0 | ||||
| -rw-r--r-- | docs/guide/getting-started/supported-languages.md (renamed from docs/getting-started/supported-languages.md) | 4 | ||||
| -rw-r--r-- | docs/guide/libraries/apps.md (renamed from docs/libraries/apps.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/auth.md (renamed from docs/libraries/auth.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/battery.md (renamed from docs/libraries/battery.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/bluetooth.md (renamed from docs/libraries/bluetooth.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/hyprland.md (renamed from docs/libraries/hyprland.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/mpris.md (renamed from docs/libraries/mpris.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/network.md (renamed from docs/libraries/network.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/notifd.md (renamed from docs/libraries/notifd.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/powerprofiles.md (renamed from docs/libraries/powerprofiles.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/references.md (renamed from docs/libraries/references.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/river.md (renamed from docs/libraries/river.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/tray.md (renamed from docs/libraries/tray.md) | 0 | ||||
| -rw-r--r-- | docs/guide/libraries/wireplumber.md (renamed from docs/libraries/wireplumber.md) | 0 | ||||
| -rw-r--r-- | docs/index.md | 17 | ||||
| -rw-r--r-- | docs/showcases/Showcase.vue | 6 | ||||
| -rw-r--r-- | docs/showcases/index.md | 9 | ||||
| -rw-r--r-- | docs/showcases/showcases.ts | 4 | ||||
| -rw-r--r-- | docs/vitepress.config.ts | 57 |
30 files changed, 63 insertions, 44 deletions
diff --git a/docs/ags/cli-app.md b/docs/guide/ags/cli-app.md index ceed56a..ceed56a 100644 --- a/docs/ags/cli-app.md +++ b/docs/guide/ags/cli-app.md diff --git a/docs/ags/faq.md b/docs/guide/ags/faq.md index 61c9bff..6edc250 100644 --- a/docs/ags/faq.md +++ b/docs/guide/ags/faq.md @@ -272,7 +272,7 @@ notifd.get_notifications() // ✅ ## How to create regular floating windows -Use `Gtk.Window` with [Widget.astalify](/ags/widget#how-to-use-non-builtin-gtk-widgets). +Use `Gtk.Window` with [Widget.astalify](/guide/ags/widget#how-to-use-non-builtin-gtk-widgets). By default `Gtk.Window` is destroyed on close. To prevent this add a handler for `delete-event`. diff --git a/docs/ags/first-widgets.md b/docs/guide/ags/first-widgets.md index fa5b00f..2c64732 100644 --- a/docs/ags/first-widgets.md +++ b/docs/guide/ags/first-widgets.md @@ -264,7 +264,7 @@ return <MyWidget myprop="hello"> The state of widgets are handled with Bindings. A `Binding` lets you connect the state of one [GObject](https://docs.gtk.org/gobject/class.Object.html) to another, in our case it is used to rerender part of a widget based on the state of a `GObject`. -A `GObject` can be a [Variable](./variable) or it can be from a [Library](/libraries/references). +A `GObject` can be a [Variable](./variable) or it can be from a [Library](../libraries/references). We use the `bind` function to create a `Binding` object from a `Variable` or a regular GObject and one of its properties. @@ -313,7 +313,7 @@ return <box> ::: Here is an example of a battery percent label that binds the `percentage` -property of the Battery object from the [Battery Library](/libraries/battery): +property of the Battery object from the [Battery Library](/guide/libraries/battery): ```tsx import Battery from "gi://AstalBattery" diff --git a/docs/ags/installation.md b/docs/guide/ags/installation.md index 0adcf68..0adcf68 100644 --- a/docs/ags/installation.md +++ b/docs/guide/ags/installation.md diff --git a/docs/ags/theming.md b/docs/guide/ags/theming.md index ea83e35..ea83e35 100644 --- a/docs/ags/theming.md +++ b/docs/guide/ags/theming.md diff --git a/docs/ags/utilities.md b/docs/guide/ags/utilities.md index 42589d3..42589d3 100644 --- a/docs/ags/utilities.md +++ b/docs/guide/ags/utilities.md diff --git a/docs/ags/variable.md b/docs/guide/ags/variable.md index 06098dd..96e8d38 100644 --- a/docs/ags/variable.md +++ b/docs/guide/ags/variable.md @@ -69,7 +69,7 @@ output in `Variables`. They can poll and watch at the same time, but they can only poll/watch one subprocess. :::warning -The command parameter is passed to [execAsync](/astal/ags/utilities/#executing-external-commands-and-scripts) +The command parameter is passed to [execAsync](/guide/ags/utilities#executing-external-commands-and-scripts) which means they are **not** executed in a shell environment, they do **not** expand env variables like `$HOME`, and they do **not** handle logical operators like `&&` and `||`. diff --git a/docs/ags/widget.md b/docs/guide/ags/widget.md index 1fe755f..1fe755f 100644 --- a/docs/ags/widget.md +++ b/docs/guide/ags/widget.md diff --git a/docs/getting-started/installation.md b/docs/guide/getting-started/installation.md index ef5c6e8..ef5c6e8 100644 --- a/docs/getting-started/installation.md +++ b/docs/guide/getting-started/installation.md diff --git a/docs/getting-started/introduction.md b/docs/guide/getting-started/introduction.md index 7f88362..92d2ff1 100644 --- a/docs/getting-started/introduction.md +++ b/docs/guide/getting-started/introduction.md @@ -19,5 +19,5 @@ Have you ever wanted to write a custom bar, custom notification popups or an applauncher, but gave up because writing a workspace widget, implementing the notification daemon or handling a search filter was too much of a hassle? -Astal libraries have you [covered](/libraries/references), you don't have to worry about these, +Astal libraries have you [covered](/guide/libraries/references), you don't have to worry about these, you just define the layout, style it with CSS and that's it. diff --git a/docs/getting-started/nix.md b/docs/guide/getting-started/nix.md index 2b04bdc..2b04bdc 100644 --- a/docs/getting-started/nix.md +++ b/docs/guide/getting-started/nix.md diff --git a/docs/getting-started/supported-languages.md b/docs/guide/getting-started/supported-languages.md index 06ce51c..634bad0 100644 --- a/docs/getting-started/supported-languages.md +++ b/docs/guide/getting-started/supported-languages.md @@ -2,7 +2,7 @@ ## JavaScript -The main intended usage of Astal is in TypeScript with [AGS](/ags/first-widgets). +The main intended usage of Astal is in TypeScript with [AGS](/guide/ags/first-widgets). It supports JSX and has a state management solution similar to web frameworks. Only a minimal knowledge of JavaScript's syntax is needed to get started. @@ -19,7 +19,7 @@ Examples: Similar to how there is a [TypeScript](https://github.com/Aylur/astal/tree/main/core/gjs) lib for GJS, there is also an accompanying library for [Lua](https://github.com/Aylur/astal/tree/main/core/lua). <!--TODO: open issue and link performance issue--> -Unfortunately, I have encountered very heavy [performance issues]() with [lgi](https://github.com/lgi-devs/lgi), +Unfortunately, I have encountered very heavy [performance issues](https://github.com/aylur/astal) with [lgi](https://github.com/lgi-devs/lgi), and so currently I don't recommend using Lua for full desktop shells, but only for static components that don't render child nodes dynamically, bars and panels for example. diff --git a/docs/libraries/apps.md b/docs/guide/libraries/apps.md index c53daf0..c53daf0 100644 --- a/docs/libraries/apps.md +++ b/docs/guide/libraries/apps.md diff --git a/docs/libraries/auth.md b/docs/guide/libraries/auth.md index 1f07a17..1f07a17 100644 --- a/docs/libraries/auth.md +++ b/docs/guide/libraries/auth.md diff --git a/docs/libraries/battery.md b/docs/guide/libraries/battery.md index b42d747..b42d747 100644 --- a/docs/libraries/battery.md +++ b/docs/guide/libraries/battery.md diff --git a/docs/libraries/bluetooth.md b/docs/guide/libraries/bluetooth.md index 04d9db2..04d9db2 100644 --- a/docs/libraries/bluetooth.md +++ b/docs/guide/libraries/bluetooth.md diff --git a/docs/libraries/hyprland.md b/docs/guide/libraries/hyprland.md index faf9e50..faf9e50 100644 --- a/docs/libraries/hyprland.md +++ b/docs/guide/libraries/hyprland.md diff --git a/docs/libraries/mpris.md b/docs/guide/libraries/mpris.md index dfe7956..dfe7956 100644 --- a/docs/libraries/mpris.md +++ b/docs/guide/libraries/mpris.md diff --git a/docs/libraries/network.md b/docs/guide/libraries/network.md index afeb5d2..afeb5d2 100644 --- a/docs/libraries/network.md +++ b/docs/guide/libraries/network.md diff --git a/docs/libraries/notifd.md b/docs/guide/libraries/notifd.md index 7e02149..7e02149 100644 --- a/docs/libraries/notifd.md +++ b/docs/guide/libraries/notifd.md diff --git a/docs/libraries/powerprofiles.md b/docs/guide/libraries/powerprofiles.md index 8571c29..8571c29 100644 --- a/docs/libraries/powerprofiles.md +++ b/docs/guide/libraries/powerprofiles.md diff --git a/docs/libraries/references.md b/docs/guide/libraries/references.md index 8f2bd02..8f2bd02 100644 --- a/docs/libraries/references.md +++ b/docs/guide/libraries/references.md diff --git a/docs/libraries/river.md b/docs/guide/libraries/river.md index 4818d0b..4818d0b 100644 --- a/docs/libraries/river.md +++ b/docs/guide/libraries/river.md diff --git a/docs/libraries/tray.md b/docs/guide/libraries/tray.md index c8d093b..c8d093b 100644 --- a/docs/libraries/tray.md +++ b/docs/guide/libraries/tray.md diff --git a/docs/libraries/wireplumber.md b/docs/guide/libraries/wireplumber.md index 5f1daab..5f1daab 100644 --- a/docs/libraries/wireplumber.md +++ b/docs/guide/libraries/wireplumber.md diff --git a/docs/index.md b/docs/index.md index 46f28da..f22ae19 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,13 +10,13 @@ hero: actions: - theme: brand text: What is Astal? - link: /getting-started/introduction + link: /guide/getting-started/introduction - theme: alt text: Get Started - link: /getting-started/installation + link: /guide/getting-started/installation - theme: alt text: References - link: /libraries/references + link: /guide/libraries/references features: - title: Use Your Preferred Language @@ -29,12 +29,6 @@ features: icon: <i style="color:var(--vp-c-brand-3)" class="fl-gtk"></i> details: With Astal you work with Gtk directly. You are not limited to only a set of them. --- -<script setup> -import Showcases from './showcases/Showcases.vue' -</script> - -<Showcases /> - <!--TODO: add icons for buttons https://github.com/vuejs/vitepress/pull/3795--> <style> @@ -64,6 +58,11 @@ import Showcases from './showcases/Showcases.vue' font-weight: bold; } + .VPFooter { + background-color: transparent !important; + border: none; + } + .VPNavBar:not(.top) { background-color: transparent !important; -webkit-backdrop-filter: blur(16px); diff --git a/docs/showcases/Showcase.vue b/docs/showcases/Showcase.vue index 5873a8e..a5a1e01 100644 --- a/docs/showcases/Showcase.vue +++ b/docs/showcases/Showcase.vue @@ -1,7 +1,7 @@ <script setup> const props = defineProps({ src: { type: String, required: true }, - author: { type: String, required: true }, + label: { type: String, required: true }, url: { type: String, required: true } }); </script> @@ -9,10 +9,10 @@ const props = defineProps({ <template> <figure> <a :href="url"> - <img :src="src" :alt="author" /> + <img :src="src" :alt="label" /> </a> <figcaption> - <span>Author: {{ author }}</span> + <span>{{ label }}</span> </figcaption> </figure> </template> diff --git a/docs/showcases/index.md b/docs/showcases/index.md new file mode 100644 index 0000000..21b54b7 --- /dev/null +++ b/docs/showcases/index.md @@ -0,0 +1,9 @@ +--- +layout: home +--- + +<script setup> +import Showcases from './Showcases.vue' +</script> + +<Showcases /> diff --git a/docs/showcases/showcases.ts b/docs/showcases/showcases.ts index fa0a7bb..138ae7f 100644 --- a/docs/showcases/showcases.ts +++ b/docs/showcases/showcases.ts @@ -1,5 +1,5 @@ type Showcase = { - author: string + label: string src: string url: string } @@ -10,6 +10,6 @@ type Grid<T> = T | [T, T, T, T] export default [ - { author: "Aylur", src: "/astal/showcase/aylur1.png", url: "https://github.com/Aylur/dotfiles" }, + { label: "Placeholder (this is an ags v1 screenshot)", src: "/astal/showcase/aylur1.png", url: "https://github.com/Aylur/dotfiles" }, // add more showcases here ] satisfies Array<Grid<Showcase>> diff --git a/docs/vitepress.config.ts b/docs/vitepress.config.ts index aa6aae2..25d9e36 100644 --- a/docs/vitepress.config.ts +++ b/docs/vitepress.config.ts @@ -13,7 +13,6 @@ export default defineConfig({ cleanUrls: true, lastUpdated: true, - ignoreDeadLinks: true, // FIXME: head: [ ["link", { rel: "icon", href: "/astal/icon.svg" }], @@ -27,18 +26,30 @@ export default defineConfig({ copyright: 'Logo is created by VDawg' }, - nav: [{ - text: "0.1.0", - items: [ - { text: "Contributing", link: github("/blob/main/CONTRIBUTING.md") }, - { text: "Changelog", link: github("/blob/main/CHANGELOG.md") }, - ], - }], + nav: [ + { + text: "Showcases", + link: "/showcases", + activeMatch: "/showcases/", + }, + { + text: "Guide", + link: "/guide/getting-started/installation", + activeMatch: "/guide/", + }, + { + text: "0.1.0", + items: [ + { text: "Contributing", link: github("/blob/main/CONTRIBUTING.md") }, + { text: "Changelog", link: github("/blob/main/CHANGELOG.md") }, + ], + } + ], sidebar: [ { text: "Getting Started", - base: "/getting-started", + base: "/guide/getting-started", collapsed: false, items: [ { text: "Introduction", link: "/introduction" }, @@ -48,7 +59,7 @@ export default defineConfig({ }, { text: "AGS", - base: "/ags", + base: "/guide/ags", collapsed: false, items: [ { text: "Installation", link: "/installation" }, @@ -65,20 +76,20 @@ export default defineConfig({ text: "Libraries", collapsed: true, items: [ - { text: "References", link: "/libraries/references" }, + { text: "References", link: "/guide/libraries/references" }, { text: "Astal", link: "https://aylur.github.io/libastal" }, - { text: "Apps", link: "/libraries/apps" }, - { text: "Auth", link: "/libraries/auth" }, - { text: "Battery", link: "/libraries/battery" }, - { text: "Bluetooth", link: "/libraries/bluetooth" }, - { text: "Hyprland", link: "/libraries/hyprland" }, - { text: "Mpris", link: "/libraries/mpris" }, - { text: "Network", link: "/libraries/network" }, - { text: "Notifd", link: "/libraries/notifd" }, - { text: "PowerProfiles", link: "/libraries/powerprofiles" }, - { text: "River", link: "/libraries/river" }, - { text: "Tray", link: "/libraries/tray" }, - { text: "WirePlumber", link: "/libraries/wireplumber" }, + { text: "Apps", link: "/guide/libraries/apps" }, + { text: "Auth", link: "/guide/libraries/auth" }, + { text: "Battery", link: "/guide/libraries/battery" }, + { text: "Bluetooth", link: "/guide/libraries/bluetooth" }, + { text: "Hyprland", link: "/guide/libraries/hyprland" }, + { text: "Mpris", link: "/guide/libraries/mpris" }, + { text: "Network", link: "/guide/libraries/network" }, + { text: "Notifd", link: "/guide/libraries/notifd" }, + { text: "PowerProfiles", link: "/guide/libraries/powerprofiles" }, + { text: "River", link: "/guide/libraries/river" }, + { text: "Tray", link: "/guide/libraries/tray" }, + { text: "WirePlumber", link: "/guide/libraries/wireplumber" }, ], }, ], |