Skip to content

Commit 1162987

Browse files
committed
feat: add markdown editor images videos
1 parent 03248f7 commit 1162987

6 files changed

Lines changed: 21 additions & 10 deletions

File tree

docs/07-Pro Features/04-markdown-editor.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,26 @@
22
title: Markdown Editor
33
---
44

5+
import React from 'react';
6+
import VideoPlayer from '@site/src/components/Video/player';
7+
58
:::info Pro Feature
69
[Upgrade to Phoenix Code Pro](https://phcode.io/pricing) to access this feature.
710
:::
811

912
Phoenix Code supports a full rich text editing experience for Markdown files, right inside the Live Preview. Format text, build tables, drop in images, add links, use slash commands, and watch every change sync back to your source code instantly.
1013

11-
<!-- Add an image here showing the Markdown Editor in edit mode with the toolbar visible -->
14+
<VideoPlayer
15+
src="https://docs-images.phcode.dev/website/videos/markdown-pro-dialog.mp4"
16+
/>
1217

1318
## Enabling Edit Mode
1419

1520
To start editing, click the **Edit** button on the right side of the markdown toolbar. The toolbar expands to show formatting options, and you can start making changes right away.
1621

1722
To go back to the read-only view, click **Reader** in the same place.
1823

19-
<!-- Add an image here showing the Edit button in the toolbar -->
24+
![Edit button in the markdown toolbar](./images/markdown-edit-button.png "The Edit button in the markdown toolbar")
2025

2126
> By default, markdown files open in Edit mode for **Phoenix Code Pro** users.
2227
@@ -28,7 +33,9 @@ Scrolling in either view does the same: the other view follows along to keep you
2833

2934
Use the **cursor sync** button in the toolbar to toggle this behavior on or off.
3035

31-
<!-- Add an image here showing the cursor sync button in the toolbar -->
36+
<VideoPlayer
37+
src="https://docs-images.phcode.dev/videos/markdown/toggle-cursor-sync.mp4"
38+
/>
3239

3340
## Text Formatting
3441

@@ -42,7 +49,7 @@ Select the text you want to format and click a formatting button, or use the key
4249

4350
You can also select text and use the **floating format bar** that appears near your selection.
4451

45-
<!-- Add an image here showing the floating format bar appearing above selected text -->
52+
![Floating format bar above selected text](./images/markdown-format-bar.png "The floating format bar appears near your selection")
4653

4754
## Blocks and Lists
4855

@@ -54,13 +61,13 @@ The toolbar lets you change the current block type using a **block type dropdown
5461
- **Table** (see [Table Editing](#table-editing))
5562
- **Mermaid diagram** with a syntax editor and live rendered preview
5663

57-
<!-- Add an image here showing the block type dropdown with heading options -->
64+
![Markdown toolbar with block type dropdown and block insertion buttons](./images/markdown-blocks-lists.png "The markdown toolbar in Edit mode")
5865

5966
## Slash Menu
6067

6168
Type `/` at the start of an empty line to open the **Slash Menu**. This gives you a quick way to insert any block type without reaching for the toolbar.
6269

63-
<!-- Add an image here showing the Slash Menu with the list of available items -->
70+
![Slash menu showing block type options](./images/markdown-slash-menu.png "The Slash Menu with block type options")
6471

6572
Start typing to filter the list. Use the arrow keys to navigate and press `Enter` to insert.
6673

@@ -91,7 +98,9 @@ Right-click a cell to open a context menu with options to:
9198

9299
You can also click the **+ New row** button below the table to add a row.
93100

94-
<!-- Add an image here showing the table context menu with row and column options -->
101+
<VideoPlayer
102+
src="https://docs-images.phcode.dev/videos/markdown/markdown-editor-table.mp4"
103+
/>
95104

96105
## Images
97106

@@ -102,17 +111,19 @@ You can add images in two ways:
102111

103112
Both options are available from the **Image** button in the toolbar or through the [Slash Menu](#slash-menu).
104113

105-
Click an image in the editor to see a popover with **Edit** and **Delete** buttons.
114+
![Image button dropdown with Image URL and Upload from Computer options](./images/markdown-image-options.png "The Image button dropdown")
106115

107-
<!-- Add an image here showing the image popover with Edit and Delete buttons -->
116+
Click an image in the editor to see a popover with **Edit** and **Delete** buttons.
108117

109118
## Links
110119

111120
To add a link, select some text and click the **Link** button in the toolbar (or press `Ctrl/Cmd + K`). Enter the URL in the floating input that appears and press `Enter`.
112121

113122
Click an existing link to see a popover showing the URL, with options to **Edit** or **Remove** the link.
114123

115-
<!-- Add an image here showing the link popover with the URL, Edit button, and Remove button -->
124+
<VideoPlayer
125+
src="https://docs-images.phcode.dev/videos/markdown/markdown-editor-links.mp4"
126+
/>
116127

117128
## Keyboard Shortcuts
118129

16.7 KB
Loading
34.7 KB
Loading
15.6 KB
Loading
34.9 KB
Loading
70.3 KB
Loading

0 commit comments

Comments
 (0)