Skip to content

Commit 613f038

Browse files
committed
feat: better organization of the getting started section
1 parent afc2668 commit 613f038

6 files changed

Lines changed: 185 additions & 203 deletions

File tree

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
---
2+
title: Installation Guide
3+
slug: "/intro"
4+
---
5+
6+
import Tabs from '@theme/Tabs';
7+
import TabItem from '@theme/TabItem';
8+
9+
# Phoenix Code Installation Guide
10+
11+
Phoenix Code is a text editor designed to make coding as intuitive and fun as playing a video game — specially crafted for web developers, designers, and students. This guide walks you through downloading and installing Phoenix Code on Windows, macOS, and Linux, or running it straight from your browser with no install at all.
12+
13+
## Download
14+
15+
Visit the official website — [phcode.io](https://phcode.io) — and click the **Download** button to grab the installer for your operating system.
16+
17+
![Download Phoenix Code from the website](../images/Website/download.png)
18+
19+
> **Linux users:** see [Installing on Linux](#linux) below for the one-line terminal installer.
20+
21+
### Choosing a different installer
22+
23+
If you need a build for another operating system, or have specific requirements:
24+
25+
1. Click the **Download** drop-down on the website.
26+
2. Select the installer you need from the list.
27+
28+
![Download options drop-down](../images/Website/downloadOptions.png)
29+
30+
Phoenix Code supports a wide range of operating systems:
31+
32+
- **macOS** — Apple Silicon (M1+) and Intel chipsets
33+
- **Windows** — x64 architectures
34+
- **Linux** — Ubuntu, Debian, Pop!_OS, Fedora, Arch, and more
35+
36+
## Install
37+
38+
### Windows & macOS
39+
40+
Run the downloaded installer and follow the on-screen instructions. Once it finishes, launch Phoenix Code and you're ready to start building.
41+
42+
### Linux {#linux}
43+
44+
Open a terminal and run the official installer script — copy it from the website or use the command below:
45+
46+
```bash
47+
wget -qO- https://updates.phcode.io/linux/installer.sh | bash
48+
```
49+
50+
![Linux install command](../images/Website/linuxCmd.png)
51+
52+
This installs Phoenix Code along with all required dependencies, and sets up app-drawer shortcuts and file associations automatically. It works on all major distributions, including Ubuntu, Debian, Fedora, and Arch-based systems.
53+
54+
Need to install by hand, check dependencies, or uninstall? See [Advanced Linux installation](#linux-advanced) below.
55+
56+
## Use it in the browser
57+
58+
Prefer not to install anything? Run the full editor right in your browser at [phcode.dev](https://phcode.dev) — perfect for Chromebooks, tablets, or just trying things out. Everything runs locally in the browser, with nothing to download.
59+
60+
---
61+
62+
## Advanced Linux installation {#linux-advanced}
63+
64+
The one-line installer above is all most users need. The sections below cover manual installation, runtime dependencies, and common questions.
65+
66+
### Uninstalling
67+
68+
To remove an automatic installation, run:
69+
70+
```bash
71+
wget -qO- https://updates.phcode.io/linux/installer.sh | bash -s -- --uninstall
72+
```
73+
74+
For a manual installation, delete the folder where you placed the Phoenix Code app, along with any related files.
75+
76+
### Manual installation
77+
78+
If automatic installation fails, or you prefer to install by hand:
79+
80+
1. **Check your GLIBC version:**
81+
```bash
82+
ldd --version | awk '/ldd/{print $NF}'
83+
```
84+
85+
2. **Download the package:** visit the [Phoenix Code releases page](https://github.com/phcode-dev/phoenix-desktop/releases) and download a build compatible with your GLIBC version.
86+
87+
3. **Extract it:**
88+
```bash
89+
tar -xvf phoenix_code_version.tar.gz
90+
```
91+
92+
4. **Read the bundled instructions:**
93+
```bash
94+
cat extracted_folder/ReadMe.txt
95+
```
96+
97+
5. **Follow the steps** in `ReadMe.txt` to complete the installation.
98+
99+
### Desktop environment compatibility
100+
101+
Phoenix Code is tested on both **GNOME** and **KDE**. Other desktop environments may work via [manual installation](#manual-installation).
102+
103+
### Dependencies
104+
105+
If Phoenix doesn't start after installing, restart your system and confirm the required dependencies for your distribution are installed:
106+
107+
<Tabs
108+
defaultValue="ubuntu"
109+
values={[
110+
{ label: 'Ubuntu/Debian', value: 'ubuntu' },
111+
{ label: 'Fedora/Red Hat', value: 'fedora' },
112+
{ label: 'Arch Linux', value: 'arch' },
113+
]}>
114+
115+
<TabItem value="ubuntu">
116+
117+
Update your package list:
118+
```bash
119+
sudo apt update
120+
```
121+
122+
Install WebKitGTK and GTK:
123+
```bash
124+
sudo apt install libgtk-3-0 libwebkit2gtk-4.0-37
125+
```
126+
*Note: In Ubuntu 22+ versions, WebKitGTK may be pre-installed.*
127+
128+
Install optional GStreamer plugins for media playback:
129+
```bash
130+
sudo apt install gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-tools gstreamer1.0-libav
131+
```
132+
133+
</TabItem>
134+
<TabItem value="fedora">
135+
136+
Update your package list:
137+
```bash
138+
sudo dnf update
139+
```
140+
141+
Install WebKitGTK and GTK:
142+
```bash
143+
sudo dnf install webkit2gtk3 gtk3
144+
```
145+
146+
Install optional GStreamer plugins for media playback:
147+
```bash
148+
sudo dnf install gstreamer1-plugins-base gstreamer1-plugins-good gstreamer1-plugins-bad-free gstreamer1-plugins-bad-freeworld gstreamer1-plugins-ugly gstreamer1-libav
149+
```
150+
151+
</TabItem>
152+
<TabItem value="arch">
153+
154+
Ensure your system is up to date:
155+
```bash
156+
sudo pacman -Syu
157+
```
158+
159+
Install WebKitGTK and GTK:
160+
```bash
161+
sudo pacman -S webkit2gtk gtk3
162+
```
163+
164+
Install optional GStreamer plugins for media playback:
165+
```bash
166+
sudo pacman -S gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav
167+
```
168+
169+
</TabItem>
170+
</Tabs>
171+
172+
### FAQ
173+
174+
**How can I verify my distribution is supported?**
175+
176+
Run the [one-line installer](#linux). If it completes successfully, your distribution is supported.
177+
178+
**How do I upgrade Phoenix Code?**
179+
180+
For automatic installations, you'll get an update notification in the app itself. For manual installations, repeat the [manual installation](#manual-installation) steps.
181+
182+
**Phoenix won't start after installing — what can I do?**
183+
184+
Restart your system, then confirm the [dependencies](#dependencies) for your distribution are installed.

docs/01-Getting Started/02-installation.md

Lines changed: 0 additions & 54 deletions
This file was deleted.
File renamed without changes.

docs/01-Getting Started/03-Linux.md

Lines changed: 0 additions & 149 deletions
This file was deleted.
File renamed without changes.

docusaurus.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,7 @@ const config = {
161161
...appLinks,
162162
{ from: '/docs/Features/recent-files', to: '/docs/file-management#recent-files' },
163163
{ from: '/docs/Features/live-preview-settings', to: '/docs/Features/Live Preview/live-preview-settings' },
164+
{ from: '/docs/Linux', to: '/docs/intro#linux' },
164165
],
165166
createRedirects(existingPath) {
166167
if (existingPath !== '/') {

0 commit comments

Comments
 (0)