summaryrefslogtreecommitdiff
path: root/docs/getting-started
diff options
context:
space:
mode:
authorAylur <[email protected]>2024-09-12 00:40:04 +0200
committerGitHub <[email protected]>2024-09-12 00:40:04 +0200
commit6c5d7659a75c093588117c4c28dd046409b3ac8f (patch)
treec120efe485c6d699d29480e12298c2cd7fe4626c /docs/getting-started
parentd203255ec20bb6e3b2917dd4aee53dee3a090137 (diff)
parent8b75dadc76274692988eb317d3cc6ce1aaa44780 (diff)
Merge pull request #5 from Aylur/nix/lua-builder
lua example, nix builder
Diffstat (limited to 'docs/getting-started')
-rw-r--r--docs/getting-started/installation.md2
-rw-r--r--docs/getting-started/nix.md31
-rw-r--r--docs/getting-started/supported-languages.md3
3 files changed, 25 insertions, 11 deletions
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
index bbdced9..ef5c6e8 100644
--- a/docs/getting-started/installation.md
+++ b/docs/getting-started/installation.md
@@ -4,7 +4,7 @@
maintainer: [@Aylur](https://github.com/Aylur)
-Read more about it on the [nix page](./nix)
+Read more about it on the [nix page](./nix#astal)
## Arch
diff --git a/docs/getting-started/nix.md b/docs/getting-started/nix.md
index 3c3e8a9..2f320f3 100644
--- a/docs/getting-started/nix.md
+++ b/docs/getting-started/nix.md
@@ -6,19 +6,32 @@ Using Astal on Nix will require you to package your project.
:::code-group
-```nix [typescript.nix]
-# Not documented yet
-```
+```nix [<i class="devicon-lua-plain"></i> Lua]
+{
+ inputs = {
+ nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+ astal = {
+ inputs.nixpkgs.follows = "nixpkgs";
+ url = "github:nixos/nixpkgs/nixos-unstable";
+ };
+ };
-```nix [lua.nix]
-# Not documented yet
+ outputs = { self, nixpkgs, astal }: let
+ system = "x86_64-linux";
+ pkgs = nixpkgs.legacyPackages.${system};
+ in {
+ packages.${system}.default = astal.lib.mkLuaPacakge {
+ inherit pkgs;
+ };
+ };
+}
```
-```nix [python.nix]
+```nix [<i class="devicon-python-plain"></i> Python]
# Not documented yet
```
-```nix [vala.nix]
+```nix [<i class="devicon-vala-plain"></i> Vala]
# Not documented yet
```
@@ -34,7 +47,7 @@ Example content of a `flake.nix` file that contains your `homeConfigurations`.
:::code-group
-```nix [flake.nix]
+```nix [<i class="devicon-nixos-plain"></i> flake.nix]
{
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
@@ -71,7 +84,7 @@ Example content of `home.nix` file
:::code-group
-```nix [home.nix]
+```nix [<i class="devicon-nixos-plain"></i> home.nix]
{ inputs, pkgs, ... }:
{
# add the home manager module
diff --git a/docs/getting-started/supported-languages.md b/docs/getting-started/supported-languages.md
index f69dd19..7d8fc5f 100644
--- a/docs/getting-started/supported-languages.md
+++ b/docs/getting-started/supported-languages.md
@@ -25,7 +25,8 @@ components that don't render child nodes dynamically, bars and panels for exampl
Examples:
-- TODO
+- [Simple Bar](https://github.com/Aylur/astal/tree/main/examples/lua/simple-bar)
+![simple-bar](https://github.com/user-attachments/assets/a306c864-56b7-44c4-8820-81f424f32b9b)
## Python