Skip to content

Commit 33116cc

Browse files
HumXCHumXC
committed
update
1 parent 43c993b commit 33116cc

File tree

14 files changed

+530
-4
lines changed

14 files changed

+530
-4
lines changed

‎config/_default/languages.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ languageName = 'English'
77
title = 'MikaShell'
88
weight = 10
99
[en.params]
10+
alertText = "MikaShell is under active development and is not yet stable!"
1011
footer = 'Brought to you by <a class="text-muted" href="https://thulite.io/">Thulite</a>'
1112

1213
[zh-cn]

‎content/en/docs/_index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Docs"
3+
description: ""
4+
summary: ""
5+
date: 2023-09-07T16:12:03+02:00
6+
lastmod: 2023-09-07T16:12:03+02:00
7+
draft: false
8+
weight: 999
9+
toc: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---

‎content/en/docs/guides/_index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: "Guides"
3+
description: ""
4+
summary: ""
5+
date: 2025-09-26T14:43:11+08:00
6+
draft: false
7+
weight: 100
8+
toc: true
9+
seo:
10+
title: "" # custom title (optional)
11+
description: "" # custom description (recommended)
12+
canonical: "" # custom canonical URL (optional)
13+
noindex: false # false (default) or true
14+
---

‎content/en/docs/guides/install.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: "Installation"
3+
slug: "install"
4+
description: ""
5+
summary: ""
6+
date: 2025-09-27T14:39:55+08:00
7+
draft: false
8+
weight: 102
9+
toc: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---
16+
17+
## Nixos
18+
19+
Use this flake:
20+
21+
`https://github.com/MikaShell/mika-shell/blob/main/flake.nix`
22+
23+
There are two packages in the package: `default` and `debug`. `default` is built with `release-fast`.
24+
If you encounter problems, try using the `debug` package, which outputs more debugging information.
25+
However, in some cases it may run slower than the `default` package and consume more CPU.
26+
27+
## Other Distributions
28+
29+
Sorry, I currently don’t have the energy to package for other distributions.
30+
Below are some general manual installation steps you can follow:
31+
32+
1. First, download the binary from the [releases](https://github.com/MikaShell/mika-shell/releases) page.
33+
2. Confirm the required dynamic library dependencies:
34+
35+
MikaShell uses several dependency libraries, mainly:
36+
37+
```bash
38+
libdbus libgtk4 webkitgtk6 libgtk4-layer-shell libwebp libinput libpng librsvg2
39+
```
40+
41+
Different distributions may have different library names, so please check accordingly.
42+
43+
If the application still doesn’t work after installing the libraries above, you can use the `ldd` command to find missing dynamic libraries and install the corresponding packages.
44+
You can also refer to the [build CI](https://github.com/MikaShell/mika-shell/blob/b916ab3af1194782b61ee7c34c14438048f0264a/.github/workflows/build.yaml#L16) in the repository for the listed library dependencies.

‎content/en/docs/guides/other-dependencies.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
slug: "other-dependencies"
3+
title: "Other Dependencies"
4+
description: ""
5+
summary: ""
6+
date: 2025-09-27T17:22:58+08:00
7+
draft: false
8+
weight: 103
9+
toc: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---
16+
In some cases, certain Webview features may not work properly, such as playing videos or audio.
17+
These features may require additional GStreamer plugins to be installed.
18+
19+
For Nixos, you may need the following packages:
20+
21+
```nix
22+
gst_all_1.gst-plugins-base
23+
gst_all_1.gst-plugins-good
24+
gst_all_1.gst-plugins-bad
25+
gst_all_1.gst-plugins-ugly
26+
gst_all_1.gst-libav
27+
gst_all_1.gstreamer
28+
```
29+
30+
Other distributions should be similar.
31+
Please note that you don’t need to install all of these packages—only those plugins that support the features you need.
32+
Of course, if you’re unsure which plugin a feature depends on, you can just install all of them.
33+
34+
If you want to know which GStreamer plugins are installed on your system, you can check the `GST_PLUGIN_SYSTEM_PATH_1_0` environment variable.
35+
36+
After installing mika-shell, running the `mika-shell` command will print some helpful information.

‎content/en/docs/guides/started.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
slug: "get-started"
3+
title: "Get Started"
4+
description: "An introduction to what MikaShell is and what it can do."
5+
summary: "MikaShell is an open-source desktop shell building tool that runs in a Wayland environment."
6+
date: 2025-09-26T14:43:11+08:00
7+
draft: false
8+
weight: 101
9+
toc: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---
16+
This guide will walk you through the installation, configuration, and usage of MikaShell to help you get started quickly.
17+
18+
## What is MikaShell?
19+
20+
MikaShell is an open-source desktop shell building tool that runs in a Wayland environment.
21+
Built on top of `Gtk4` and `WebkitGtk6`, it enables you to quickly create beautiful, efficient, and user-friendly desktop environments.
22+
23+
## What does MikaShell do?
24+
25+
MikaShell displays HTML pages as `Layer` or `Window` objects in a Wayland environment and provides access to certain interfaces required to build “desktop components” (for example: system tray, workspaces, etc.).
26+
These interfaces might be implemented via dbus or more complex calls, and MikaShell provides `JS/TS` bindings for the front end.

‎content/en/docs/guides/use.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
slug: "use"
3+
title: "Usage"
4+
description: ""
5+
summary: ""
6+
date: 2025-09-27T20:11:40+08:00
7+
draft: false
8+
weight: 104
9+
toc: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---
16+
17+
## Data Storage
18+
19+
If for some reason you need to clear the data generated by mika-shell, it’s helpful to know the following:
20+
21+
- `$XDG_CONFIG_HOME/mika-shell` is the directory where configuration files and frontend files are stored.
22+
Or you might be more familiar with this path: `$HOME/.config/mika-shell`
23+
24+
- `$XDG_DATA_HOME/webkitgtk/` is the directory where Webview data is stored.
25+
Website-generated data such as cache, cookies, and localStorage will be saved here.
26+
Or more commonly: `$HOME/.local/share/webkitgtk/`
27+
28+
- `$XDG_CACHE_HOME/webkitgtk/` is the directory where Webview cache is stored.
29+
Cache files will be saved here.
30+
Or more commonly: `$HOME/.cache/webkitgtk/`
31+
32+
- mika-shell also creates files like `/tmp/mika-shell-xxxx.sock` in the `/tmp` directory for IPC.
33+
34+
{{< callout type="warning" >}}
35+
`$HOME/.local/share/webkitgtk/` and `$HOME/.local/share/webkitgtk/` may be changed in the future to a more recognizable directory,
36+
for example: `$HOME/.local/share/mika-shell/`
37+
{{< /callout >}}
38+
39+
## Run
40+
41+
You can execute `mika-shell -h` to get more command-line help.
42+
43+
Start mika-shell with the following command:
44+
45+
```bash
46+
mika-shell daemon
47+
```
48+
49+
If the configuration directory does not exist, running `mika-shell daemon` will automatically create the [default configuration files](https://github.com/MikaShell/mika-shell/tree/main/example).
50+
If everything is working correctly, you should see a simple bar appear at the top of the screen.
51+
Click the Debug button on the left side of the bar to view more examples, and right-click to open the web debugging tools.
52+
53+
The initial configuration is mainly intended for development, testing, and exploring features, and is not suitable for daily use.
54+
In the next chapter, I will introduce how to create your own configuration from scratch.

‎content/en/docs/tutorial/_index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: "Tutorial"
3+
description: ""
4+
summary: ""
5+
date: 2025-09-26T14:43:11+08:00
6+
draft: false
7+
weight: 200
8+
toc: true
9+
seo:
10+
title: "" # custom title (optional)
11+
description: "" # custom description (recommended)
12+
canonical: "" # custom canonical URL (optional)
13+
noindex: false # false (default) or true
14+
---

‎content/en/docs/tutorial/before-starting.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
slug: "before-starting"
3+
title: "Before Starting"
4+
description: ""
5+
summary: ""
6+
date: 2025-09-29T15:11:23+08:00
7+
draft: false
8+
weight: 201
9+
toc: true
10+
seo:
11+
title: "" # custom title (optional)
12+
description: "" # custom description (recommended)
13+
canonical: "" # custom canonical URL (optional)
14+
noindex: false # false (default) or true
15+
---
16+
If you want to create a custom configuration with **mika-shell**, you’ll need some basic frontend knowledge.
17+
Even if you’ve never worked with frontend development before, you can treat mika-shell as a starting point—the frontend ecosystem is thriving, and various tools can help you quickly bring ideas to life.
18+
19+
- **Experienced Developers**<br>
20+
If you’re already proficient in frontend development, you can skip this section.
21+
22+
- **Beginners**<br>
23+
If you’re new, this section aims to provide some introductory guidance.
24+
*The author is not a frontend expert, merely sharing suggestions based on personal experience.
25+
If you have better ideas, feel free to submit a PR to improve the documentation.*
26+
27+
---
28+
29+
### Essential Basics
30+
31+
1. **Understand HTML, CSS, and JavaScript**<br>
32+
mika-shell is built on these three core technologies, so mastering them is necessary.
33+
34+
2. **Choose a Frontend Framework**<br>
35+
You can choose a framework like React, Vue, Svelte, or Solid to improve development efficiency.
36+
- [React](https://react.dev/)
37+
- [Vue](https://vuejs.org/)
38+
- [Svelte](https://svelte.dev/)
39+
- [Solid](https://www.solidjs.com/)
40+
- More frameworks...
41+
42+
3. **Use Additional Tools**<br>
43+
- [TypeScript](https://www.typescriptlang.org/) — JavaScript with type syntax.
44+
- [Tailwind CSS](https://tailwindcss.com/) — helps you avoid writing verbose CSS.
45+
- [Sass](https://sass-lang.com/) — a more advanced form of CSS.

0 commit comments

Comments
 (0)