diff options
author | Aylur <[email protected]> | 2024-09-04 23:32:53 +0000 |
---|---|---|
committer | Aylur <[email protected]> | 2024-09-04 23:32:53 +0000 |
commit | 93e41a321212361c175812788492d56e5a89ade3 (patch) | |
tree | 17d8513fb7f240acb8d9f5d5a95041a06b245e4d /docs/getting-started | |
parent | 539a6b4cc1976aafd395e29450da83a17a73a6e0 (diff) |
docs: fix links
added initial documention for each library
Diffstat (limited to 'docs/getting-started')
-rw-r--r-- | docs/getting-started/introduction.md | 2 | ||||
-rw-r--r-- | docs/getting-started/supported-languages.md | 6 |
2 files changed, 5 insertions, 3 deletions
diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md index 252484d..0b0a840 100644 --- a/docs/getting-started/introduction.md +++ b/docs/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](/astal/libraries/overview), you don't have to worry about these, +Astal libraries have you [covered](/astal/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/supported-languages.md b/docs/getting-started/supported-languages.md index 5b273b1..4ddda32 100644 --- a/docs/getting-started/supported-languages.md +++ b/docs/getting-started/supported-languages.md @@ -2,7 +2,7 @@ ## JavaScript -The main intended usage of Astal is in TypeScript with [AGS](/astal/ags/first-widgets). +The main intended usage of Astal is in TypeScript with [AGS](/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. @@ -16,7 +16,8 @@ Examples: ## Lua -Similar to how there is a [TypeScript]() lib for GJS, there is also an accompanying library for [Lua](). +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), 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. @@ -27,6 +28,7 @@ Examples: ## Python +<!--TODO: move python PR to monorepo and link--> There is a WIP [library for python](), to make it behave similar to the above two but I don't plan on finishing it, because I'm not a fan of python. If you are interested in picking it up, feel free to open a PR. |