Skip to content

Commit 4432925

Browse files
Added initial Hyprland configuration documentation
1 parent 0b8b170 commit 4432925

11 files changed

Lines changed: 86 additions & 9 deletions

File tree

astro.config.mjs

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
import { defineConfig } from "astro/config";
33
import starlight from "@astrojs/starlight";
44
import starlightImageZoom from "starlight-image-zoom";
5+
import starlightKbd from "starlight-kbd";
56

67
// https://astro.build/config
78
export default defineConfig({
@@ -10,18 +11,40 @@ export default defineConfig({
1011
plugins: [starlightImageZoom()],
1112
integrations: [
1213
starlight({
13-
plugins: [starlightImageZoom()],
14+
plugins: [
15+
starlightImageZoom(),
16+
starlightKbd({
17+
globalPicker: false,
18+
types: [{ id: "linux", label: "Linux", default: true }],
19+
}),
20+
],
1421
title: "StratOS Linux",
1522
customCss: process.env.NO_GRADIENTS
1623
? ["./src/styles/_global.css"]
1724
: ["./src/styles/landing.css", "./src/styles/_global.css"],
1825
// customCss: [ '@fontsource-variable/jetbrains-mono/400.css', '@fontsource-variable/jetbrains-mono/600.css' ],
1926
social: [
20-
{ icon:'github', label:"GitHub", href:"https://github.com/StratOS-Linux"},
21-
{ icon:'discord' ,label: "Discord", href: "https://discord.gg/DVaXRCnCet"},
22-
{ icon:'mastodon' ,label: "Mastodon" , href: "https://fosstodon.org/@StratOS"},
23-
{ icon:'x.com', label:"X (Formerly known as Twitter)", href: "https://twitter.com/StratOS_Linux"},
24-
],
27+
{
28+
icon: "github",
29+
label: "GitHub",
30+
href: "https://github.com/StratOS-Linux",
31+
},
32+
{
33+
icon: "discord",
34+
label: "Discord",
35+
href: "https://discord.gg/DVaXRCnCet",
36+
},
37+
{
38+
icon: "mastodon",
39+
label: "Mastodon",
40+
href: "https://fosstodon.org/@StratOS",
41+
},
42+
{
43+
icon: "x.com",
44+
label: "X (Formerly known as Twitter)",
45+
href: "https://twitter.com/StratOS_Linux",
46+
},
47+
],
2548
sidebar: [
2649
// {
2750
// label: 'Guides',
@@ -44,8 +67,8 @@ export default defineConfig({
4467
autogenerate: { directory: "tools" },
4568
},
4669
{
47-
label: "Strata",
48-
autogenerate: { directory: "strata" },
70+
label: "Configuration",
71+
autogenerate: { directory: "configuration" },
4972
},
5073
],
5174
}),

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
"@octokit/rest": "^22.0.0",
1717
"astro": "^5.11.0",
1818
"sharp": "^0.34.3",
19-
"starlight-image-zoom": "^0.2.0"
19+
"starlight-image-zoom": "^0.2.0",
20+
"starlight-kbd": "^0.2.1"
2021
},
2122
"devDependencies": {
2223
"wrangler": "^4.30.0"

pnpm-lock.yaml

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Hyprland Configuration and Keybinds
3+
4+
---
5+
6+
## What is Hyprland?
7+
8+
Hyprland is a dynamic tiling window manager for Linux which is highly customisable, visually appealing and lightweight. It is a very popular choice for Linux users who like a modern window manager with features like rounded corners, smooth animations and Wayland support.
9+
10+
StratOS Linux offers a Hyprland spin as an option to users trying to venture into the world of Window Managers. The config provided by default is very basic with a few EWW widgets. Users can feel free to customise their Hyprland configs as they see fit by using it as a starting point.
11+
12+
# Application Control
13+
import { Kbd } from 'starlight-kbd/components';
14+
15+
|Description| Keybinding|
16+
|-----------|-----------|
17+
| Open Zen Browser | <Kbd linux="Super+B" />|
18+
| Open Application Launcher (Vicinae) | <Kbd linux="Super+Space"/> or <Kbd linux="Super+R"/>|
19+
| Open File Manager (Thunar) | <Kbd linux="Super+E"/>|
20+
| Open Terminal (Ghostty) | <Kbd linux="Super+T"/>|
21+
| Toggle Conky Widget| <Kbd linux="Super+C"/>|
22+
| Open Clipboard Manager|<Kbd linux="Super+V"/>|
23+
| Toggle EWW widgets| <Kbd linux="Super+W"/>|
24+
| Close focused window | <Kbd linux="Super+Q"/>|
25+
26+
# Window Management
27+
28+
|Description|Keybinding|
29+
|-----------|----------|
30+
|Switch Workspaces|<Kbd linux="Super+[0-9]"/> or <Kbd linux="Super+ScrollUp/ScrollDown"/>|
31+
|Move active window between workspaces|<Kbd linux="Super+Shift+[0-9]"/>|
32+
|Move active window silently between workspaces|<Kbd linux="Super+Alt+[0-9]"/>|
33+
|Toggle scratchpad|<Kbd linux="Super+Tab"/>|
34+
35+
36+
37+
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)