Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 0 additions & 39 deletions code.mdx

This file was deleted.

6 changes: 6 additions & 0 deletions hello/hi-there.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: 'New file'
description: 'Description of your new file.'
---

New file as well.
149 changes: 0 additions & 149 deletions image-embeds.mdx

This file was deleted.

6 changes: 6 additions & 0 deletions new-file.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: 'New file'
description: 'Description of your new file.'
---

New file for testing
30 changes: 21 additions & 9 deletions web-editor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ changes, it's still helpful to know the basics of git.

Git terminology:

- **Repository**: The folder in which your code lives. It can be local (on your computer) or remote (like GitHub).
* **Repository**: The folder in which your code lives. It can be local (on your computer) or remote (like GitHub).

- **Commit**: A snapshot of changes made to files in the repository.
* **Commit**: A snapshot of changes made to files in the repository.

- **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version.
* **Branch**: A separate line of development. It's a working copy of the code that allows you to work on changes without affecting the main version.

- **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live.
* **Pull request:** A request to merge changes from a working branch into the main branch. This is used for reviewing content before making changes live.

### Making updates

In order to make updates to your docs, we include a few buttons specifically to
In order to make updates to your docs, we include a few buttons specifically to
integrate with your git workflow.

<Note>
Expand All @@ -51,6 +51,7 @@ integrate with your git workflow.

<Frame>
<img src="/images/editor/branches-light.png" className="block dark:hidden" />

<img src="/images/editor/branches-dark.png" className="hidden dark:block" />
</Frame>

Expand All @@ -59,6 +60,7 @@ integrate with your git workflow.

<Frame>
<img src="/images/editor/new-branch-light.png" className="block dark:hidden" />

<img src="/images/editor/new-branch-dark.png" className="hidden dark:block" />
</Frame>

Expand All @@ -84,6 +86,7 @@ integrate with your git workflow.

<Frame>
<img src="/images/editor/publish-button-light.png" className="block dark:hidden" />

<img src="/images/editor/publish-button-dark.png" className="hidden dark:block" />
</Frame>
</Tab>
Expand All @@ -95,6 +98,7 @@ integrate with your git workflow.

<Frame>
<img src="/images/editor/pull-request-button-light.png" className="block dark:hidden" />

<img src="/images/editor/pull-request-button-dark.png" className="hidden dark:block" />
</Frame>
</Tab>
Expand All @@ -111,6 +115,7 @@ integrate with your git workflow.

<Frame>
<img src="/images/editor/pr-modal-light.png" className="block dark:hidden" />

<img src="/images/editor/pr-modal-dark.png" className="hidden dark:block" />
</Frame>
</Step>
Expand All @@ -125,13 +130,15 @@ commands you have access to after typing `/` in the **"Visual Editor"** mode:

<Frame>
<img src="/images/editor/slash-commands-light.png" className="block dark:hidden" />

<img src="/images/editor/slash-commands-dark.png" className="hidden dark:block" />
</Frame>

As you type, you'll see more options pop up:

<Frame caption="Command filtering">
<img src="/images/editor/slash-commands-text-light.png" className="block dark:hidden" />

<img src="/images/editor/slash-commands-text-dark.png" className="hidden dark:block" />
</Frame>

Expand Down Expand Up @@ -179,20 +186,23 @@ image or use an existing image from the repo.

<Frame>
<img src="/images/editor/images-light.png" className="block dark:hidden" />

<img src="/images/editor/images-dark.png" className="hidden dark:block" />
</Frame>

Uploading an image can be done through the modal:

<Frame>
<img src="/images/editor/upload-light.png" className="block dark:hidden" />

<img src="/images/editor/upload-dark.png" className="hidden dark:block" />
</Frame>

And you can preview an existing image before you add it.

<Frame>
<img src="/images/editor/image-preview-light.png" className="block dark:hidden" />

<img src="/images/editor/image-preview-dark.png" className="hidden dark:block" />
</Frame>

Expand All @@ -203,13 +213,15 @@ and **"Edit"** buttons on the top right of the image.

<Frame>
<img src="/images/editor/edit-image-light.png" className="block dark:hidden" />

<img src="/images/editor/edit-image-dark.png" className="hidden dark:block" />
</Frame>

Clicking the **"Edit"** button lets you edit the attributes of the image.

<Frame>
<img src="/images/editor/image-form-light.png" className="block dark:hidden" />

<img src="/images/editor/image-form-dark.png" className="hidden dark:block" />
</Frame>

Expand All @@ -223,6 +235,7 @@ In order to offer the most flexibility, the editor has three modes:

<Frame caption="View mode toggle">
<img src="/images/editor/mode-toggle-light.png" className="block dark:hidden" />

<img src="/images/editor/mode-toggle-dark.png" className="hidden dark:block" />
</Frame>

Expand All @@ -239,10 +252,10 @@ you'd do in your IDE. This offers less flexibility, in that our components aren'
for auto-complete, but it does have two unique advantages.

1. It allows you to edit props of components (see our [limitations below](#current-limitations))
which is currently not available in **"Visual Editor"** mode yet.
which is currently not available in **"Visual Editor"** mode yet.

2. It allows you to correct syntax errors which might've appeared in your repo that
might not be compatible with **"Visual Editor"** mode until you've fixed them.
might not be compatible with **"Visual Editor"** mode until you've fixed them.

### Diff View

Expand All @@ -263,8 +276,7 @@ We do have a few current limitations in the editor that we're working to resolve
</Accordion>

<Accordion title="Snippet previews">
We currently don't show any previews for custom snippets. This is on our roadmap to support
as fully editable components.
We currently don't show any previews for custom snippets. This is on our roadmap to support as fully editable components.
</Accordion>

<Accordion title="OpenAPI previews">
Expand Down
Loading