diff --git a/editor.mdx b/editor.mdx index 3f818f824..6c8404f28 100644 --- a/editor.mdx +++ b/editor.mdx @@ -1,7 +1,7 @@ --- -title: 'Web Editor' -description: 'Build your documentation using the Mintlify Web Editor' -icon: 'mouse-pointer-2' +title: "Web Editor" +description: "Build your documentation using the Mintlify Web Editor" +icon: "mouse-pointer-2" --- Mintlify Web Editor interface in light mode + - Mode toggle in the Mintlify Web Editor - Mode toggle in the Mintlify Web Editor @@ -57,14 +59,15 @@ You can switch between modes at any time using the toggle in the top right corne Visual Mode provides a rich WYSIWYG experience where you can see exactly how your documentation will appear as you create it. - Visual editing mode in the Mintlify Web Editor - Visual editing mode in the Mintlify Web Editor @@ -74,14 +77,15 @@ Visual Mode provides a rich WYSIWYG experience where you can see exactly how you Markdown Mode provides direct access to the underlying MDX code of your documentation. This mode is preferable when you need precise control over component properties or when you're comfortable with Markdown/MDX syntax. - Markdown editing mode in the Mintlify Web Editor - Markdown editing mode in the Mintlify Web Editor @@ -93,15 +97,16 @@ Unlike the CLI where you need to know the exact syntax to add a component, the W To access the component menu, press the `/` key. - Component menu in the Mintlify Web Editor - Component menu in the Mintlify Web Editor @@ -109,7 +114,7 @@ To access the component menu, press the `/` key. The component menu gives you access to all supported elements and components, including: - + Text, headings, blockquotes @@ -147,15 +152,16 @@ The Web Editor provides an intuitive interface for making changes. When you're ready to make your changes live, click the "Publish" button in the top-right corner to publish your changes. - Publishing flow in the Mintlify Web Editor - Publishing flow in the Mintlify Web Editor @@ -190,23 +196,24 @@ When you are in a branch, you can make and save changes by clicking the "Save Ch Pull requests provide a way to review changes before they're merged into your main documentation. -### Creating a Pull Request +### Creating a Pull Request on a Branch -1. Make your changes on a feature branch -2. Click the "Create Pull Request" button in the top-right corner -3. Add a title and description for your pull request -4. Click "Create Pull Request" +1. Make your changes on a branch +2. Click the "Publish Pull Request" button in the top-right corner +3. Add a Pull Request Title and Description for your pull request +4. Click "Publish Pull Request" - Pull request creation in the Mintlify Web Editor - Pull request creation in the Mintlify Web Editor @@ -225,13 +232,9 @@ The Web Editor seamlessly integrates with your Git repository, ensuring that all ### How Git Sync Works 1. **Authentication**: The Web Editor connects to your Git repository through our [GitHub App](/settings/github) or [GitLab integration](/settings/gitlab). - 2. **Automatic Fetching**: When you open the editor, it automatically fetches the latest content from your repository's main branch. - 3. **Change Tracking**: As you make edits in the Web Editor, changes are tracked and can be committed to your repository. - 4. **Branching**: Changes can be made directly to your main branch or to a separate feature branch, depending on your workflow preferences. - 5. **Pull Requests**: For collaborative workflows, you can create pull requests directly from the Web Editor. ## Git Terminology @@ -241,37 +244,21 @@ While not necessary, understanding the following terms will help you work more e The following terms are used in the Web Editor and are also used in the Git workflow. - - - -A repository (or "repo") is where your documentation files are stored, along with their revision history. The Web Editor connects to your Git repository to fetch and store documentation content. - - - - - -A commit is a snapshot of changes to your documentation at a specific point in time. When you publish changes in the Web Editor, you're creating a commit in your Git repository. - - - - - -A branch is a parallel version of your documentation that allows you to work on changes without affecting the main version. The Web Editor allows you to create and switch between branches. - - - - - -A pull request (PR) is a proposal to merge changes from one branch into another, typically from a feature branch into the main branch. PRs facilitate review and discussion before changes are incorporated. - - - - - -A diff (or difference) shows the specific changes between two versions of a file. When reviewing pull requests, diffs highlight what has been added, removed, or modified. - - - + + A repository (or "repo") is where your documentation files are stored, along with their revision history. The Web Editor connects to your Git repository to fetch and store documentation content. + + + A commit is a snapshot of changes to your documentation at a specific point in time. When you publish changes in the Web Editor, you're creating a commit in your Git repository. + + + A branch is a parallel version of your documentation that allows you to work on changes without affecting the main version. The Web Editor allows you to create and switch between branches. + + + A pull request (PR) is a proposal to merge changes from one branch into another, typically from a feature branch into the main branch. PRs facilitate review and discussion before changes are incorporated. + + + A diff (or difference) shows the specific changes between two versions of a file. When reviewing pull requests, diffs highlight what has been added, removed, or modified. + ## Troubleshooting @@ -279,42 +266,40 @@ A diff (or difference) shows the specific changes between two versions of a file Here are solutions to common issues you might encounter with the Web Editor. - - -**Possible causes:** -- Deployment is still in progress -- Caching issues in your browser + + **Possible causes:** -**Solutions:** -1. Check deployment status in your Mintlify Dashboard -2. Try hard refreshing your browser (Ctrl+F5 or Cmd+Shift+R) -3. Clear your browser cache + - Deployment is still in progress + - Caching issues in your browser - + **Solutions:** - + 1. Check deployment status in your Mintlify Dashboard + 2. Try hard refreshing your browser (Ctrl\+F5 or Cmd\+Shift\+R) + 3. Clear your browser cache + + + **Possible causes:** -**Possible causes:** -- Insufficient permissions to the Git repository -- Authentication issues with your Git provider + - Insufficient permissions to the Git repository + - Authentication issues with your Git provider -**Solutions:** -1. Verify you have correct access to the repository -2. Check if your Git integration is properly configured -3. Review the [Editor Permissions](/advanced/dashboard/permissions) documentation + **Solutions:** - + 1. Verify you have correct access to the repository + 2. Check if your Git integration is properly configured + 3. Review the [Editor Permissions](/advanced/dashboard/permissions) documentation + + + **Possible causes:** - + - Network connectivity problems + - Large documentation repositories -**Possible causes:** -- Network connectivity problems -- Large documentation repositories + **Solutions:** -**Solutions:** -1. Check your internet connection -2. Refresh the page and try again -3. Contact support if the issue persists - - - + 1. Check your internet connection + 2. Refresh the page and try again + 3. Contact support if the issue persists + + \ No newline at end of file