Skip to content

Commit 5067feb

Browse files
committed
feat: write extensions section
1 parent 8534d0e commit 5067feb

11 files changed

Lines changed: 196 additions & 132 deletions

docs/03-customizing-editor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Phoenix Code ships with two built-in themes:
1919
- **Phoenix Dark Neo**: default dark theme
2020
- **Phoenix Light Neo**: default light theme
2121

22-
You can install more themes, create your own, or remove themes you have installed, see [Extensions](./popular-extensions).
22+
You can install more themes, create your own, or remove themes you have installed, see [Extensions](./extensions).
2323

2424
### Switching the Theme
2525

2626
Open `View > Themes...` and pick a theme from the **Current Theme** dropdown. The change applies immediately.
2727

2828
![Current Theme and Use Theme Scrollbars in the Themes Settings dialog](./images/editingText/themes-settings-theme.png "View > Themes...: pick a theme and toggle theme scrollbars")
2929

30-
Click **Get More...** to browse community themes. See [Extensions](./popular-extensions) for installation steps.
30+
Click **Get More...** to browse community themes. See [Extensions](./extensions) for installation steps.
3131

3232
### Use Theme Scrollbars
3333

docs/06-extensions.md

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
---
2+
title: Extensions
3+
draft: true
4+
---
5+
6+
import React from 'react';
7+
import VideoPlayer from '@site/src/components/Video/player';
8+
9+
> **DRAFT — pending media.** Prose is complete. The workflow video and one updated UI screenshot are pending; placeholders inline. Remove this banner and the `draft: true` frontmatter once captured. Popular extensions descriptions were moved verbatim from the old `popular-extensions.md` and still need a style cleanup pass.
10+
11+
Phoenix Code supports extensions for adding features, themes, and language support. All extensions are managed through the built-in **Extension Manager**.
12+
13+
---
14+
15+
## Opening the Extension Manager
16+
17+
> **IMAGE TO TAKE**: Screenshot of the current Phoenix Code interface with a callout / arrow pointing to the Extension Manager button. We need this because the sidebar UI changed in this release and the old screenshot is stale.
18+
19+
Click the **Extension Manager** button in the sidebar to open the dialog.
20+
21+
---
22+
23+
## The Extension Manager dialog
24+
25+
The dialog has four tabs along the top:
26+
27+
| Tab | What it shows |
28+
| --- | --- |
29+
| **Available** | Extensions you can install from the marketplace. |
30+
| **Themes** | Themes you can install from the marketplace. |
31+
| **Installed** | Extensions and themes already installed. |
32+
| **Updates** | Extensions with newer versions available. |
33+
34+
> **VIDEO TO RECORD**: 30 to 60 seconds. Walk through the basic workflow with one clean run, no narration needed:
35+
> 1. Open the Extension Manager.
36+
> 2. Browse the **Available** tab and install one extension.
37+
> 3. Switch to the **Installed** tab to show it listed.
38+
> 4. Remove that same extension and confirm the reload.
39+
>
40+
> Suggested host path: `https://docs-images.phcode.dev/videos/extensions/extension-manager-workflow.mp4`
41+
42+
{/* <VideoPlayer src="https://docs-images.phcode.dev/videos/extensions/extension-manager-workflow.mp4" /> */}
43+
44+
---
45+
46+
## Installing an extension
47+
48+
1. Open the Extension Manager.
49+
2. Switch to the **Available** tab.
50+
3. Find the extension by scrolling or using the search box.
51+
4. Click **Install** on the extension card.
52+
5. Click **Close** when the install confirmation appears.
53+
54+
Some extensions require a reload, which the dialog prompts for.
55+
56+
---
57+
58+
## Updating extensions
59+
60+
1. Open the Extension Manager.
61+
2. Switch to the **Updates** tab. Available updates are listed here.
62+
3. Click **Update** on any extension to upgrade it.
63+
64+
If the Updates tab is empty, all your extensions are current.
65+
66+
---
67+
68+
## Removing an extension
69+
70+
1. Open the Extension Manager.
71+
2. Switch to the **Installed** tab.
72+
3. Find the extension and click **Remove**.
73+
4. In the confirmation popup, click **Remove Extensions and Reload**.
74+
75+
Phoenix Code reloads to finalize the removal.
76+
77+
---
78+
79+
## Themes
80+
81+
Themes use the same Extension Manager as other extensions, with a separate **Themes** tab for browsing.
82+
83+
### Installing a theme
84+
85+
1. Open the Extension Manager.
86+
2. Switch to the **Themes** tab.
87+
3. Find the theme and click **Install**.
88+
89+
Once installed, switch to it from `View > Themes...`. See [Customizing the Editor → Themes](./customizing-editor#themes).
90+
91+
### Applying a theme from the Extension Manager
92+
93+
You can also apply an installed theme without leaving the dialog:
94+
95+
1. Open the Extension Manager.
96+
2. Switch to the **Installed** tab.
97+
3. Find the theme and click **Apply**.
98+
99+
### Removing a theme
100+
101+
A theme is removed the same way as any other extension:
102+
103+
1. Open the Extension Manager.
104+
2. Switch to the **Installed** tab.
105+
3. Find the theme and click **Remove**.
106+
4. Confirm with **Remove Extensions and Reload**.
107+
108+
---
109+
110+
## Creating your own
111+
112+
To create your own theme or extension, see the API section:
113+
114+
- [Creating Themes](/api/creating-themes)
115+
- [Creating Extensions](/api/creating-extensions)
116+
- [Creating Node Extensions](/api/creating-node-extensions)
117+
- [Debugging Extensions](/api/debugging-extensions)
118+
- [Publishing Extensions](/api/publishing-extensions)
119+
120+
---
121+
122+
## Popular extensions
123+
124+
A curated list of community extensions worth checking out.
125+
126+
### Minimap
127+
Created by: [Zorgzerg](https://github.com/zorgzerg)
128+
129+
This extension adds a minimap preview of your code on the side of your editor, making it easier to navigate and get an overview of your code structure.
130+
131+
For more details, visit the [GitHub repository](https://github.com/zorgzerg/brackets-minimap) of the extension.
132+
133+
`Minimap` in action :-
134+
![Minimap](./images/popular-extensions/minimap.png)
135+
136+
---
137+
138+
### Show Whitespace
139+
Created by: [Dennis Kehrig](https://github.com/DennisKehrig)
140+
141+
This extension allows users to visualize spaces and tabs, making code more readable and helping maintain formatting consistency.
142+
143+
For more details, visit the [GitHub repository](https://github.com/DennisKehrig/brackets-show-whitespace) of the extension.
144+
145+
`Show Whitespace` in action :-
146+
![Show Whitespace](./images/popular-extensions/Show-Whitespace.png)
147+
148+
---
149+
150+
### 1-2-3
151+
Created by: [Michal Jeřábek](https://github.com/michaljerabek)
152+
153+
This extension generates number sequences directly in your editor, making it easy to create ordered lists or numbered markers with minimal effort.
154+
155+
For more details, visit the [GitHub repository](https://github.com/michaljerabek/1-2-3) of the extension.
156+
157+
`1-2-3` in action :-
158+
![1-2-3](./images/popular-extensions/1-2-3.gif)
159+
160+
---
161+
162+
### FuncDocr
163+
Created by: [Ole Kröger](https://github.com/Wikunia)
164+
165+
This extension generates JS/PHPDocs for your functions, keeping your code documented and organized.
166+
167+
For more details, visit the [GitHub repository](https://github.com/wikunia/brackets-funcdocr) of the extension.
168+
169+
`FuncDocr` in action :-
170+
![FuncDocr](./images/popular-extensions/Func-Docr.gif)
171+
172+
---
173+
174+
### Remove Comments
175+
Created by: [Pluto](https://github.com/devvaannsh)
176+
177+
This extension allows you to remove unwanted comments from your code. You can delete all comments at once or only those within a selected section.
178+
179+
For more details, visit the [GitHub repository](https://github.com/devvaannsh/Remove-Comments) of the extension.
180+
181+
`Remove Comments` in action :-
182+
<VideoPlayer src="https://docs-images.phcode.dev/videos/popular-extensions/Remove-Comments.mp4" />
183+
184+
---
185+
186+
### Autosave Files on Window Blur
187+
Created by: [Marty Penner](https://github.com/martypenner)
188+
189+
This extension automatically saves all unsaved files whenever Phoenix Code loses focus (for example, when you switch to another application).
190+
191+
For more details, visit the [GitHub repository](https://github.com/martypenner/brackets-autosave-files-on-window-blur) of the extension.
192+
193+
`Autosave Files on Window Blur` in action :-
194+
<VideoPlayer src="https://docs-images.phcode.dev/videos/popular-extensions/autosave.mp4" />

docs/06-popular-extensions.md

Lines changed: 0 additions & 79 deletions
This file was deleted.

docs/08-Features/13-themes.md

Lines changed: 0 additions & 51 deletions
This file was deleted.
-122 KB
Binary file not shown.
-12.9 KB
Binary file not shown.
-113 KB
Binary file not shown.
-304 KB
Binary file not shown.
-30.2 KB
Binary file not shown.
-180 KB
Binary file not shown.

0 commit comments

Comments
 (0)