diff --git a/.vale/styles/config/vocabularies/Mintlify/accept.txt b/.vale/styles/config/vocabularies/Mintlify/accept.txt index 575cedf8b0..02d25ec560 100644 --- a/.vale/styles/config/vocabularies/Mintlify/accept.txt +++ b/.vale/styles/config/vocabularies/Mintlify/accept.txt @@ -32,13 +32,13 @@ Atlassian (?i)auth Auth0 authed -autocommit +autocommit(s|ed|ing)? autofocuses (?i)autogenerat(e|ed|ing)? (?i)automations? (?i)automerge (?i)autoplay -autosave(s|d)? +autosav(e|es|ed|ing) AVIF AWS axios @@ -148,6 +148,7 @@ DORA (?i)drilldown DRY DynamoDB +dotfile(s)? EasyList ECS EdDSA diff --git a/changelog.mdx b/changelog.mdx index 25f7d0da37..fb9f88d1fa 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -9,8 +9,8 @@ noindex: true ## Editor and collaboration - - **Editor branches:** When you create a branch, the editor now creates a draft pull request and autosaves changes to Git. You can rename or delete branches, discard autosaved changes, and move pending changes to a new branch. The branch menu is ordered by recent activity, uses per-user branch names, and shows cleaner `Draft ` names for automatically generated branches. See [Branching and publishing](/editor/branching-and-publishing). - - **Pull requests open as drafts by default:** The editor now opens new pull requests in draft state so you can share a preview URL without signaling that the change is ready to merge. Change this on the [editor settings](/editor/settings#create-pull-requests-as-drafts-by-default) page. + - **Editor branches:** When you create a branch, the editor now creates a draft pull request and autosaves changes to Git. You can rename or delete branches, discard autosaved changes, and move pending changes to a new branch. The branch menu is ordered by recent activity, uses per-user branch names, and shows cleaner `Draft ` names for automatically generated branches. See [Branching and publishing](/editor/publish). + - **Pull requests open as drafts by default:** The editor now opens new pull requests in draft state so you can share a preview URL without signaling that the change is ready to merge. Change this on the [editor settings](/editor/settings#create-draft-pull-requests-by-default) page. - **GitLab merge requests:** Merge requests opened in GitLab now sync into editor branches, matching the existing GitHub behavior. - **Streamlined editor navigation:** The editor has a new breadcrumbs row, consolidated page and share controls, sticky sidebar section headers, and a dedicated bottom bar for settings and **Ask agent**. Site settings open as editor pages instead of a modal. Mobile navigation now uses a simplified top bar and panel-based sidebar for smaller screens. - **Page access and comments:** Request edit access to a private or protected page from the editor and review requests in an approval modal. Comment cards now show profile pictures, and @mentions link to the mentioned user. @@ -111,7 +111,7 @@ noindex: true - **Faster live previews:** Live previews load much faster on first open, new pages and `docs.json` changes appear sooner, and CSS and theme edits now update in real time. - **Live preview in the editor:** Live previews open in an editor pane instead of a new tab, and site settings and the editor agent are available while you preview. - - **Authenticated live previews:** Preview drafts of pages behind authentication from the editor [live preview](/editor/live-preview). + - **Authenticated live previews:** Preview drafts of pages behind authentication from the editor [live preview](/editor/review#live-preview). - **OpenAPI 3.1 file uploads:** The API playground now recognizes OpenAPI 3.1 files uploaded to `FileInput` fields, and file inputs support drag-and-drop. See [OpenAPI setup](/api-playground/openapi-setup) for more information. - **Markdown mode:** Use the `/` menu in Markdown mode, copy content as Markdown, and pasted Markdown in visual mode formats automatically. - **Assistant analytics:** The assistant analytics view has more context and filtering than the previous version. @@ -199,7 +199,7 @@ noindex: true ## Editor and collaboration - **Review flow:** Request review on a draft, leave feedback, and approve or request changes before publishing. Reviews now support non-deploy branches. - - **More ways to collaborate:** Start [comment threads](/editor/comments) on an entire page, mention yourself to leave a reminder, and use keyboard shortcuts Option + C or Option + S to comment on or suggest changes to selected text. + - **More ways to collaborate:** Start [comment threads](/editor/collaborate#comments) on an entire page, mention yourself to leave a reminder, and use keyboard shortcuts Option + C or Option + S to comment on or suggest changes to selected text. - **Faster, more available editing:** The editor renders without waiting for the Git file tree and people without GitHub write access can use the editor. ## Automations, integrations, and Slack @@ -918,7 +918,7 @@ noindex: true - Redesigned the editor configuration settings page with an improved layout and autosave support. - Pages auto-generated from OpenAPI specifications now appear in the web editor as read-only entries. - - Video support in [live preview](/editor/live-preview). Embedded mp4, webm, and mov files now render correctly during local development. + - Video support in [live preview](/editor/review#live-preview). Embedded mp4, webm, and mov files now render correctly during local development. - [Automations](/automations) can now be disabled and re-enabled from the dashboard. - Assistant analytics now show usage broken down by source (web vs API) in the dashboard. - Authenticated MCP search now correctly filters results based on the user's authentication groups. @@ -1412,8 +1412,8 @@ noindex: true ## Web editor improvements - - Added [shareable preview links](/editor/branching-and-publishing#access-and-share-a-preview) from the editor toolbar. - - Updated [publishing workflow](/editor/branching-and-publishing) to support one-click publishing or creating pull requests. + - Added [shareable preview links](/editor/review#preview-deployments) from the editor toolbar. + - Updated [publishing workflow](/editor/publish) to support one-click publishing or creating pull requests. - Working in the web editor no longer requires you to sign in with GitHub. ## Onboarding improvements diff --git a/deploy/authentication-setup.mdx b/deploy/authentication-setup.mdx index bf460f8572..0e5b9eaeaa 100644 --- a/deploy/authentication-setup.mdx +++ b/deploy/authentication-setup.mdx @@ -518,4 +518,4 @@ Some features behave differently or are unavailable when you enable authenticati | [skill.md](/ai/skillmd) | Full support | Not supported | Not supported | | [Sitemap](/optimize/seo#sitemaps-and-robotstxt-files) | Full support | Available behind authentication, but excludes pages in groups | Available behind authentication, but excludes pages in groups | | [robots.txt](/optimize/seo#sitemaps-and-robotstxt-files) | Full support | Available behind authentication | Available behind authentication | -| [Live preview](/editor/live-preview) | Full support | Supported for Mintlify authentication | Supported for Mintlify authentication | +| [Live preview](/editor/review#live-preview) | Full support | Supported for Mintlify authentication | Supported for Mintlify authentication | diff --git a/docs.json b/docs.json index c643ccf213..7c06f91970 100644 --- a/docs.json +++ b/docs.json @@ -121,15 +121,11 @@ "root": "editor/index", "pages": [ "editor/tutorial", - "editor/git-essentials", "editor/pages", - "editor/navigation", - "editor/live-preview", - "editor/branching-and-publishing", - "editor/comments", - "editor/suggestions", + "editor/publish", + "editor/review", + "editor/collaborate", "editor/agent", - "editor/configurations", "editor/settings", "editor/keyboard-shortcuts" ] diff --git a/editor/agent.mdx b/editor/agent.mdx index 3ac724e3bd..a6d63b71ef 100644 --- a/editor/agent.mdx +++ b/editor/agent.mdx @@ -10,17 +10,9 @@ The editor agent makes changes directly in your current branch. ## Open the agent -{/* vale Mintlify.FirstPerson = NO */} Click **Ask agent** in the editor toolbar, or press Cmd + I (macOS) or Ctrl + I (Windows). -To close the panel, click the **X** button in the panel header or press Cmd + I again. -{/* vale Mintlify.FirstPerson = YES */} - -## Send a message - -Type your request in the chat box at the bottom of the panel and press Enter or click the send button. - -Type @ to mention a specific page. The agent focuses on that page when processing your request. If you don't mention a page, the agent uses the page you currently have open. +Type @ to mention a specific page, and the agent focuses on it. Without a mention, it uses the page you currently have open. Example prompts: @@ -45,14 +37,14 @@ Mintlify strips scripts and other active content from SVG files before the agent ## Add a selection to the agent -In visual mode, select text on a page. A floating toolbar appears over the selection. Click **Add to agent** to send the selected text to the agent as context. +In visual mode, select text and click **Add to agent** in the floating toolbar to send it to the agent as context. ## Ask for comments and suggestions The agent edits content directly by default. To get feedback without immediately changing the page, explicitly ask the agent to review the page, leave comments, or make suggestions. -- [Suggestions](/editor/suggestions) propose a specific replacement that you can accept or reject. The original text remains visible with a strikethrough until you decide, and the agent can include an explanation in the suggestion thread. -- [Comments](/editor/comments) leave feedback or a question anchored to specific text without changing the page. +- [Suggestions](/editor/collaborate#suggestions) propose a specific replacement that you can accept or reject. The original text remains visible with a strikethrough until you decide, and the agent can include an explanation in the suggestion thread. +- [Comments](/editor/collaborate#comments) leave feedback or a question anchored to specific text without changing the page. Example prompts: @@ -64,7 +56,7 @@ The agent uses the page you currently have open unless you name another page. It ## Review what the agent changed -As the agent edits your pages, a **Changed files** panel appears in the chat. Expand it to see a list of every file modified in the session. Click any file to open it in diff view and compare the agent's changes against the original. +A **Changed files** panel appears in the chat as the agent works. Expand it to see every file modified in the session, and click any file to compare the changes against the original in diff view. ## What the agent can do diff --git a/editor/branching-and-publishing.mdx b/editor/branching-and-publishing.mdx deleted file mode 100644 index 646aef551e..0000000000 --- a/editor/branching-and-publishing.mdx +++ /dev/null @@ -1,192 +0,0 @@ ---- -title: "Branching and publishing" -description: "Understand how branches and protection rules determine what happens when you publish, and how to manage the full review and deployment workflow." -keywords: ["editor", "branch", "publish", "pull request", "preview", "git", "merge", "deploy"] ---- - -The web editor autosaves everything as you type, but your changes are only live when you choose to publish them. - -What happens when you publish depends on two things: **which branch you're on** and **whether that branch requires pull requests**. - -## Saving versus publishing - -**Saving** happens automatically. Mintlify stores your edits on its servers and persists them across browser tabs, devices, and network interruptions. - -**Publishing** commits your changes to your Git repository. Click **Publish** in the toolbar to open the publish menu, save your changes as a Git commit, and create a pull request. - -The editor tracks the following as pending changes: - -- Content edits in pages -- New or deleted pages -- Navigation structure changes -- Media uploads -- Configuration updates - -## What happens when you publish - -The actions available when you click the publish button depend on your current branch and whether it has branch protection rules that require pull requests. - -| Branch type | Branch protection | Available actions | -| --- | --- | --- | -| Deployment branch | None | **Publish** directly to your live site | -| Deployment branch | Pull requests required | **Create branch** to move changes to a new branch | -| Feature branch | None | **Save in branch**, **Create pull request** | -| Feature branch | Pull requests required | **Save in branch**, **Create pull request** | - -- **Publish**: Commits and deploys your changes to your live site immediately. -- **Save in branch**: Commits your changes to the feature branch without merging to your deployment branch. -- **Create branch**: Moves your pending changes to a new feature branch when you're on a protected deployment branch. -- **Create pull request**: Opens a pull request targeting your deployment branch. - -If there are no pending changes, the editor disables the publish and save actions. - - - Your live site updates after Mintlify builds and deploys your changes. This typically takes 30 seconds to a few minutes. Check the deployment status on your [dashboard](https://app.mintlify.com). - - -## When to use a branch - -**Edit directly on your deployment branch** if you do not use a Git-based workflow. - -**Create a branch** when you use a branch-based workflow where you make each change to your content on a separate branch. - -## Create and switch branches - -### Create a branch - -1. Click the branch name in the editor toolbar. -2. Click **Create new branch**. -3. If you have pending changes, choose whether to bring them to the new branch or leave them on the current branch. -4. Enter a name and click **Create branch**. - - - Use descriptive branch names so you can identify them and other people understand what each branch is for. - - -### Switch branches - -1. Click the branch name in the toolbar. -2. Search for or scroll to the branch you want. -3. Click the branch to switch to it. - - - Switching branches while you have unpublished changes prompts you to bring those changes to the new branch or leave them behind. Changes left behind remain on your original branch. - - - - To copy a branch name, hover over the branch in the dropdown and click the copy icon. This is useful when sharing the branch with teammates or referencing it in a pull request. - - -## Preview your changes - -Every time you save changes to a feature branch, Mintlify builds a preview deployment, a temporary URL where your changes render exactly as they look when published. - -### Access and share a preview - -1. Click **Publish** in the editor toolbar. -2. In the publish menu, click the preview URL. The URL format is `organization-branch-name.mintlify.site`. - - Preview URL emphasized in the publish menu. - Preview URL emphasized in the publish menu. - - -Copy the URL and send it to reviewers. The preview updates automatically each time you save to the branch. - -### Restrict access to previews - -Preview URLs are publicly accessible by default. To restrict access to members of your Mintlify organization, enable preview authentication in the [Add-ons](https://app.mintlify.com/products/addons) page of your dashboard. - -### Share editor links - -To invite a teammate to a specific page on a branch, copy the URL from your browser's address bar and share it. Anyone with access to your Mintlify organization can open the link directly in their editor session. - -The URL format is: - -```text -https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath} -``` - -For example: `https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx` - -## Review and merge pull requests - -When a pull request is open for the current branch, the publish menu shows a review panel with: - -- The pull request title, description, and whether it is a draft. -- The source and target branches. -- The number of changed files. -- The approval requirement on the deployment branch: **Approval required**, **Code owner required**, or no requirement. -- The current review status: **Approved**, **Changes requested**, or **Awaiting review**. - -Click the pull request link to open it in GitHub, GitLab, or Bitbucket. - -After a reviewer approves a pull request, click **Merge and publish** to merge and deploy directly from the editor. The editor switches to your deployment branch after merging. - -### Approve pull requests from the editor - -For GitHub repositories, reviewers can approve open pull requests in the editor. When a pull request is open, an **Approve pull request** button appears in the review panel if your account has permission to review it. Click **Approve pull request** when the changes are ready to merge. The review status updates to **Approved** and the **Merge and publish** action becomes available. - -If you use GitLab or Bitbucket, open the pull request in your Git provider to approve it. - - - Configure branch protection rules in your Git provider to require pull requests. See [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) in the GitHub help or [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) in the GitLab help. - - -### Review changes before merging - -Click any changed file in the publish menu to open it in diff view and compare your branch against the published version. In visual mode you see a visual diff. In source mode you see a text diff. Files that can't display a diff, such as images or deleted files, appear in the list but aren't clickable. - -The file tree highlights changed pages so you can see at a glance which files an [automation](/automations) or teammate touched. Unlisted pages that appear in the branch diff are also openable from the publish menu, even though they don't appear in your site navigation. - -### Open an automation run in the editor - -When an [automation](/automations) opens a pull request, you can jump straight from the run review UI or its Slack notification into the editor on the automation's branch: - -- From the **Automation Runs** page in your dashboard, click **Open in editor** on a completed run. -- From a Slack notification, click the **View changes** link. - -Either entry point opens the editor on the automation's branch with the changed pages preselected in the publish menu. You can review the diff and merge or request changes without leaving the editor. - -### Simultaneous publishing - -Only one publish can happen at a time per branch. If another team member publishes to the same branch, wait for the current publish to complete before trying again. - -### Pull request titles and descriptions - -If your organization requires pull requests, you can enter a title and description when you publish. If you leave either blank, the editor uses a default message that lists the files you created, updated, moved, or deleted. - -## Resolve conflicts - -Conflicts occur when your branch and the deployment branch have incompatible changes to the same files. For example, when you and a teammate edited the same lines in a file or moved a file to different locations. - -The editor displays a warning when conflicts block publishing. Follow the prompts to choose which version of each conflicting section to keep. - -## Collaborate in real time - -When multiple people open the same page on the same branch, they edit together in real time. Each person's cursor and edits are visible to everyone, with avatars shown in the toolbar. - -- Changes from all collaborators merge automatically. Two people editing the same section won't create conflicts. -- Undo only affects your own edits. -- If you lose your connection, edits save locally and sync when you reconnect. - -When the [Mintlify agent](/agent) edits a page through the API or MCP, it appears in the editor like any other collaborator. You see the agent's avatar in the toolbar and a live cursor at its most recent edit location. The cursor clears automatically after the agent finishes. - -## Git sync - -When someone pushes changes to your repository from outside the editor, the editor incorporates those changes automatically. - -Non-overlapping changes apply automatically. If a remote change and your local edit affect the same part of a page, the editor highlights the conflict so you can resolve it. - -## Commit signing - -Sign commits with your GitHub account by authorizing it in your [account settings](https://app.mintlify.com/settings/account). Without authorization, the Mintlify GitHub App signs commits made in the web editor. - -For a reference of how editor actions map to Git operations, see [Git essentials](/editor/git-essentials#how-the-editor-maps-to-git). diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx new file mode 100644 index 0000000000..a5fa675881 --- /dev/null +++ b/editor/collaborate.mdx @@ -0,0 +1,66 @@ +--- +title: "Collaborate in the editor" +sidebarTitle: "Collaborate" +description: "Leave comments, propose changes as suggestions, and edit alongside teammates in real time in the editor." +keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "real time"] +--- + +Work with your team on a page by commenting on it, suggesting changes to it, or editing it together at the same time. + +## Comments + +Comments let you leave feedback on specific text without editing the content. + +**Comments never reach your repository.** They live only inside the editor and are never included in the published site or committed to Git. + +To add a comment, highlight text and click the **Comment** icon in the toolbar. To reply, click the highlighted text or the thread in the comment sidebar. + + + The comment button in the floating toolbar above selected text in the editor. + The comment button in the floating toolbar above selected text in the editor. + + +All [roles](/dashboard/roles) can comment and reply, including viewers. Only editors and admins can resolve threads. Resolving a thread removes it from the sidebar and clears the highlight from the page. + +You can delete your own comments and admins can delete any comment. Deleting the first comment in a thread deletes the entire thread. + +Type `@` to mention a teammate. They must be a member of your organization and they receive an email notification. + +If your branch has an open pull request, Mintlify adds a summary of unresolved threads to the pull request description, with a link back to each comment. The summary updates as threads change. + +## Suggestions + +Suggestions propose a change while leaving the current content in place, so a teammate can accept or reject it. + +Editors and admins can accept or reject any suggestion. Viewers cannot. + +To make a suggestion, highlight text and click the **Switch to Suggesting** button in the toolbar. In suggesting mode, your deletions and insertions appear as highlighted text rather than edits. Pending suggestions appear in the sidebar alongside comments. + + + [Viewers](/dashboard/roles) are always in suggesting mode. Suggesting mode activates automatically when a viewer opens the editor so that they can propose changes without editing content directly. + + +Click a highlighted suggestion to accept or reject it. Either choice resolves and deletes the suggestion thread. An accepted change becomes part of your current branch and goes live the next time you [publish](/editor/publish). + +## Ask the Mintlify agent + +Mention `@mintlify` in a comment, suggestion, or reply to ask the [editor agent](/editor/agent) about the current page. The agent runs in the background with the page, thread, and branch as context, then posts its answer as a reply in the same thread. + +```text +@mintlify does this endpoint support pagination? +@mintlify are there any pages that contradict this? +``` + +The agent runs read-only when replying to comments. It can search your docs, read pages, fetch web content, and load skills, but it cannot edit content, create suggestions, or publish. To make changes, open the [editor agent](/editor/agent) directly. + +Mentions work on private pages for members who already have access. Each reply counts toward your editor agent usage. + +## Real-time editing + +When multiple people open the same page on the same branch, they edit together. Each person's cursor and edits are visible to everyone, with avatars in the toolbar. + +- Changes from all collaborators merge automatically. Two people editing the same section won't create conflicts. +- Undo only affects your own edits. +- If you lose your connection, edits save locally and sync when you reconnect. + +When the [Mintlify agent](/agent) edits a page through the API or MCP, it appears like any other collaborator, with an avatar and a live cursor at its most recent edit. The cursor clears when the agent finishes. diff --git a/editor/comments.mdx b/editor/comments.mdx deleted file mode 100644 index 8db8f5b98d..0000000000 --- a/editor/comments.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "Comment on pages in the editor" -sidebarTitle: "Comments" -description: "Leave inline comments on pages in the editor to give feedback, ask questions, mention teammates, and resolve threads before you publish changes." -keywords: ["editor", "comments", "collaboration", "feedback", "mentions", "threads"] ---- - -Comments let you and your team leave feedback on specific text in a page without editing the content. Use comments to ask questions, flag issues, or discuss changes before you publish them. - -Comments live only inside the editor. They are never included in the published site or committed to your repository. - -All [roles](/dashboard/roles)—viewers, editors, and admins—can leave and reply to comments. Only editors and admins can resolve comment threads. - -If your branch has an open pull request, Mintlify adds a summary of unresolved comment threads to the pull request description. The summary lists the files with open comments, the first comment in each thread, and a link to navigate to the comment in the editor. - -The summary updates when you add, resolve, or delete a comment. - -## Add a comment - -1. Highlight the text you want to comment on. -2. Click the **Comment** icon in the toolbar. -3. Type your comment and press Enter to submit. - - - The comment button in the floating toolbar above selected text in the web editor. - The comment button in the floating toolbar above selected text in the web editor. - - -## Reply to a comment - -To open a comment thread, click the highlighted text or click the thread in the comment sidebar. Type your reply and press Enter to submit. - - - A comment thread opened in the web editor and two comment threads in the sidebar. - A comment thread opened in the web editor and two comment threads in the sidebar. - - -## Mention a teammate - -Type `@` in a comment or reply to mention a teammate. People must be a member of your organization for you to mention them. - -Mentioned teammates receive an email notification. - -## Ask the Mintlify agent - -Mention `@mintlify` in a comment, [suggestion](/editor/suggestions), or reply to ask the [editor agent](/editor/agent) a question about the current page. The agent runs asynchronously with the page, thread, and branch as context, then posts its answer as a new reply in the same thread. - -Use `@mintlify` mentions to ask questions like: - -- `@mintlify does this endpoint support pagination?` -- `@mintlify is this the recommended way to configure webhooks?` -- `@mintlify are there any pages that contradict this?` - -The agent runs in read-only mode when replying to comments. It can search your docs, read pages, fetch web content, and load skills, but it cannot edit content, create suggestions, or publish changes. To make changes, open the [editor agent](/editor/agent) directly. - -`@mintlify` mentions work on private pages for members who already have access. Each agent reply counts toward your editor agent usage. - -## Resolve a comment - -Editors and admins can resolve threads when a discussion is complete. - -Click the checkmark icon to resolve a thread. Resolving a thread removes it from the comment sidebar and clears the highlight from the page. - - - A comment thread opened in the web editor with the checkmark icon to resolve the thread highlighted. - A comment thread opened in the web editor with the checkmark icon to resolve the thread highlighted. - - -## Delete a comment - -Click the trashcan icon beside a comment to delete it. Deleting the first comment in a thread deletes the entire thread. - -You can delete your own comments. Admins can delete any comment. diff --git a/editor/configurations.mdx b/editor/configurations.mdx deleted file mode 100644 index 5b3c41c3bc..0000000000 --- a/editor/configurations.mdx +++ /dev/null @@ -1,198 +0,0 @@ ---- -title: "Configurations" -description: "Edit site branding, appearance, navigation, and feature settings from the Configurations panel in the Mintlify web editor, with real-time team sync." -keywords: ["editor", "configurations", "settings", "branding", "theme"] -boost: 3 ---- - -Configure your site's branding, appearance, and features from the **Site configurations** panel in the web editor. Configuration changes sync in real time with other editors on the same branch, so your team always sees the latest settings. - -To open the panel, click the configurations icon in the editor toolbar. - - - Configurations menu in the editor. - Configurations menu in the editor. - - -The panel groups settings into sections that map to the top-level properties in your [`docs.json`](/organize/settings). - -## General - -Set your site's identity and how it appears to visitors. - -- **Name**: The name of your project. Appears in browser tabs and search results. -- **Description**: Brief overview of your project. Used for SEO and answer engine optimization (AEO). - -## Branding - -Upload the marks that identify your site. - -- **Logo**: Your brand logo. Upload PNG or JPG files. Set separate light and dark versions and an optional click-through URL. To use an SVG logo, add the file to your repository and reference its path in your [`docs.json`](/organize/settings-appearance#logos). -- **Favicon**: Small icon that appears in browser tabs. Upload ICO, PNG, GIF, or JPG files. Set separate light and dark versions if needed. - -## Styling - -Control your site's visual identity and color scheme. - -- **Theme**: Choose a [theme](/customize/themes) for your site's overall appearance. -- **Primary color**: The main accent color used throughout your site for links, buttons, and highlights. -- **Light color**: Accent color used in dark mode. How themes apply this varies by theme. -- **Dark color**: Accent color used in light mode. How themes apply this varies by theme. -- **Background color**: Custom background colors for light and dark modes. -- **Icon library**: Icon library used for all icon properties. Defaults to `fontawesome`. -- **Strict appearance**: Lock the site to a single appearance mode and hide the theme toggle. -- **Default appearance**: Whether your site loads in `system`, `light`, or `dark` mode by default. -- **Background decoration**: Apply a visual style (`gradient`, `grid`, or `windows`) to your background. -- **Background image**: Optional background image. Set a single image or separate light and dark versions. - -## Typography - -Replace default fonts with your brand's typography. - -- **Font family**: Any [Google Fonts](https://fonts.google.com/) family works out of the box. For a self-hosted font, provide a source URL and format (`woff` or `woff2`). -- **Weight**: Typically `400` for regular and `700` for bold. Variable fonts support precise weights like `550`. -- **Heading font**: Optional override applied to all headings (`h1` through `h6`). -- **Body font**: Optional override applied to body text and the remainder of the page. - -## Navbar - -Add navigation elements to the top of your site. - -- **Primary button**: The main call-to-action in your header. Set the type, label, and destination URL. -- **Navbar links**: Additional navigation links in your header. Each link includes text and a URL. - -## Footer - -Add links and social media handles to your site footer. - -- **Social links**: Profiles on platforms like GitHub, X, LinkedIn, Discord, YouTube, and Slack. -- **Footer columns**: Enable to organize footer links into up to four columns with custom headings. - -## Banner - -Display an announcement bar across the top of every page. - -- **Content**: The banner text. Supports basic MDX formatting like links, bold, and italic. Custom components are not supported. -- **Dismissible**: Show a dismiss button on the right side of the banner. -- **Type**: Visual style. `info` uses the primary brand color, `warning` uses an amber background, and `critical` uses a red background. Defaults to `info`. -- **Color**: Override the banner background color with a custom hex color. Set separate light and dark values for theme-aware colors. - -## Thumbnail - -Customize page thumbnails and social previews. - -- **Background**: Custom background image for thumbnails. -- **Appearance**: Render thumbnails in `light` or `dark` mode. When unset, thumbnails are auto-generated from your theme colors. -- **Font**: Custom font for text in thumbnails. - -## Content - -Customize how content appears on your site. - -- **Page eyebrow**: Show small labels preceding page titles. Choose `section` or `breadcrumbs`. -- **Timestamps**: Show the date the content was last modified on all pages. -- **LaTeX**: Load LaTeX (KaTeX) stylesheets for mathematical notation rendering. - -## Code blocks - -Configure syntax highlighting and code block behavior. - -- **Code block theme**: Match the site light/dark mode with `system`, always use a dark theme with `dark`, or pick a custom [Shiki](https://shiki.style/) theme. -- **Custom code languages**: Register additional syntax highlighting languages. - -## Context menu - -Configure the quick actions surfaced in the page context menu. - -- **Options**: Multi-select dropdown of actions like `copy`, `view`, and opening the page in `chatgpt`, `claude`, `cursor`, and other AI assistants. -- **Display**: Where to display the options. `header` (default) shows them in the top-of-page context menu; `toc` shows them in the table of contents sidebar. - -## Navigation - -Tune navigation behavior across your site. - -- **Drilldown**: Auto-navigate to the first page when a user clicks a navigation group. - -## Search - -Customize the search experience and feedback. - -- **Search placeholder**: The text that appears in the search box before users type. Default is `Search or ask`. -- **Feedback**: Show thumbs-up and thumbs-down buttons or a "Suggest edits" link on every page. - -## API reference - -Document your API endpoints. - -- **OpenAPI specs**: Add OpenAPI specification files to generate API reference pages. -- **AsyncAPI specs**: Add AsyncAPI specification files to generate API reference pages. -- **MDX server**: Custom MDX server endpoints for the API playground. -- **Playground display**: Show the interactive API playground, the simple API playground, or no API playground. -- **Proxy server**: Enable or disable the proxy server for API requests. -- **MDX schema**: Whether to render the schema section on API reference pages. - -## Redirects - -Use the **Redirects** section to add, edit, search, and remove redirects without manually editing your `docs.json` file. Redirects send users from old URLs to new ones, which is useful when you rename pages or restructure your site. For more information, see [Redirects](/create/redirects). - -Each redirect has the following fields: - -- **Source**: The path to redirect from, like `/old-path`. Supports wildcards. -- **Destination**: The path to redirect to, like `/new-path`. Supports wildcards. -- **Status**: The HTTP status code for the redirect. - - `308`: Permanent redirect. Use this for content that has moved permanently. This is the default status. - - `307`: Temporary redirect. Use this when the move is temporary. - - - Redirects menu in the editor. - Redirects menu in the editor. - - -To add a redirect: - -1. Click **Add redirect**. -2. Enter the source and destination. -3. Click **Save**. - -To edit or remove an existing redirect, hover over the row and use the inline edit icon or the **X** to remove it. - -## SEO - -Configure metatags and indexing for search engines. - -- **Metatags**: Custom `` tags applied across your site. Add key-value pairs for tags like `og:image` or `twitter:card`. -- **Indexing**: Choose whether to index hidden pages. - -## Analytics - -Connect analytics platforms to track visitor behavior. Supported providers include Amplitude, Mixpanel, Heap, Google Analytics, Google Tag Manager, PostHog, Plausible, Fathom, Segment, Hightouch, Hotjar, LogRocket, Microsoft Clarity, Intercom, Clearbit, and more. - -Each entry renders as an inline row. Use the **X** icon to remove an integration. - -## 404 page - -Customize the experience when a user lands on a missing page. - -- **Redirect to home**: When on, missing pages redirect to your home page. When off, the site shows a 404 page and you can customize the title and description below. -- **Title**: Heading shown on the 404 page. -- **Description**: Subheading shown on the 404 page. - -## Variables - -Define custom variables that can be re-used throughout your content. Each variable is a key-value pair. Use the **X** icon to remove a variable. diff --git a/editor/git-essentials.mdx b/editor/git-essentials.mdx deleted file mode 100644 index b4e809642a..0000000000 --- a/editor/git-essentials.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "Git essentials for the editor" -sidebarTitle: "Git essentials" -description: "Understand the Git version control concepts behind the Mintlify editor, including branches, commits, pull requests, and merge workflows." -keywords: ["git", "version control", "web editor", "branches", "commits", "pull requests", "PRs"] ---- - -Git lets you control and track changes to files. It's the version control system behind branch-based workflows, where you manage content the same way you would any other codebase. - -The web editor handles Git operations for you. Understanding a few key concepts helps you get the most out of the editor and collaborate effectively with your team. - -## What Git does for your content - -Git tracks every change made to your content. It records what changed, who changed it, when they changed it, and why. This means you can: - -- See the full history of any page. -- Undo changes by reverting to a previous version. -- Work on updates without affecting your live site. -- Review changes before they go live. - -Your repository is the collection of files and their history that makes up your site. The editor connects to this repository to sync and publish your content. - -## Key concepts - -These are the Git concepts you'll encounter most often when using the web editor. - - - - A saved snapshot of your changes at a specific point in time. Each commit includes a message describing what changed and creates a permanent record in your project history. - - When you publish changes, the web editor creates a commit in your Git repository. - - - A separate line of work in your repository. Sometimes called a **feature branch**. - - Your live site builds from a **deployment branch**, usually called `main`. Other branches let you work on changes independently without affecting your live site. Nothing on a branch goes live until you merge it into your deployment branch with a pull request. - - Switch between branches using the branch dropdown in the editor toolbar. If you have unpublished changes, the editor lets you bring them to the new branch or leave them on your current branch. - - - The branch that builds your live site, typically called `main`. Changes merged into this branch automatically deploy to your site. - - - A proposal to merge changes from one branch into another. Pull requests let your team review and discuss changes before they go live. - - When you publish changes on a feature branch (or when your repository requires pull requests), the web editor creates a pull request. Your team reviews and merges the pull request in your Git provider (GitHub, GitLab, or Bitbucket). - - - Combining changes from one branch into another. After your team reviews and approves a pull request, merging the branch incorporates your changes into the deployment branch and publishes them. - - - Occurs when two branches have incompatible changes to the same files. The editor helps you resolve conflicts when they occur. - - - A comparison showing the differences between two versions of a file. The editor shows a visual diff of your pending changes before you publish so you can review exactly what gets committed. - - - -## How the editor maps to Git - -Every action in the web editor corresponds to a Git operation. Here is the full reference: - -| Action in the editor | Git operation | -|---|---| -| Edit a page | Changes auto-save to Mintlify servers. No Git commit yet. | -| Publish on your deployment branch | `git commit` and `git push`. Triggers a deployment. | -| Save in branch | `git commit` to the current feature branch. | -| Create pull request | `git push` and opens a pull request against your deployment branch. | -| Merge and publish | Merges the pull request and triggers a deployment. | -| Create a branch | `git checkout -b ` | -| Switch branches | `git checkout ` | -| External push or CLI update | Incoming changes sync into the editor automatically using a three-way merge. | diff --git a/editor/index.mdx b/editor/index.mdx index 3b14a32deb..bf98d3468e 100644 --- a/editor/index.mdx +++ b/editor/index.mdx @@ -1,84 +1,86 @@ --- title: "Editor overview" sidebarTitle: "Overview" -description: "Create, edit, and publish content in your browser with real-time team collaboration, automatic saving, live previews, and continuous Git sync." -keywords: ["editor", "visual", "collaborative", "web editor"] +description: "Create, edit, and publish content in your browser with the Mintlify editor. Supports real-time collaboration and continuous Git sync." +keywords: ["web editor", "git", "branches", "commits", "pull requests"] --- - A step-by-step walkthrough: create a branch, make a change, share a preview, and publish. + Create a branch, make a change, share a preview, and publish. -## Open the editor +Use the editor to write and publish documentation in your browser. The editor uses a docs-as-code workflow with all your changes backed by Git. Your work saves as commits in your repository and the editor manages Git operations for you. -Open the editor from the [Editor](https://app.mintlify.com/editor) tab in your Mintlify dashboard. Any member of your organization can open the editor, but what you can do inside depends on your [role](/dashboard/roles). Admins and editors can edit and publish, and viewers can browse content and leave [comments](/editor/comments) or [suggestions](/editor/suggestions). +The editor loads by default when you open your [dashboard](https://app.mintlify.com). Anyone in your organization can open it, but certain actions depend on your [role](/dashboard/roles). Admins and editors can edit and publish. Viewers can browse content and leave [comments and suggestions](/editor/collaborate). ## How the editor works -**Changes save automatically.** As you type, the editor saves your work. Your changes persist across tabs, devices, and network interruptions. Changes only go live when you publish them. +**Changes save automatically, but saving is separate from publishing.** As you type, the editor stores your work. Your changes persist across tabs, devices, and network interruptions. For any changes to reach your live site, you must [publish](/editor/publish) them. -**Git stays in sync.** When someone else pushes changes to your repository from outside the editor, those changes appear in the editor automatically. You don't need to pull or refresh. The editor merges non-conflicting changes and highlights anything that needs your attention. +**Publishing writes to Git.** When you publish, the editor commits your changes to your repository. If you publish to your deployment branch, this updates your live site immediately. On a feature branch, you can choose whether publishing updates your live site immediately or opens a pull request for review. - - If the editor ever appears out of sync with your repository, use [Reset editor](/editor/settings#reset-editor) to force a resync from Git. For example, the file tree is empty or shows `Unable to find docs.json` even though the file is present on your deployment branch. - +**Git stays in sync.** When someone pushes to your repository, those changes appear automatically. You don't need to pull or refresh. The editor merges non-conflicting changes and flags anything that needs your attention. -**Publishing writes to Git.** When you publish, the editor commits your changes to your repository. On a deployment branch, this updates your live site immediately. On a feature branch, it creates a pull request. +**Your team edits together.** Multiple people can edit the same page at once, with live cursors showing who is working where. Comments and suggestions are visible to everyone. -**Your team edits together.** Multiple people can edit the same page simultaneously. Live cursors show who is editing and where. + + If the editor ever appears out of sync with your repository, use [Reset editor](/editor/settings#reset-editor) to force a resync. For example, an empty file tree or the error `Unable to find docs.json` appears when the file is present on your deployment branch. + -## The editor layout +## Editor layout - Screenshot of the editor showing the branch selector, ask agent button, publish button, navigation sidebar, and top bar. - Screenshot of the editor showing the branch selector, ask agent button, publish button, navigation sidebar, and top bar. + Screenshot of the editor with the Publishing tab selected. + Screenshot of the editor with the Publishing tab selected. -- **Top bar**: Use the top bar to control what branch you work on, access the agent, preview, and publish changes. -- **Navigation sidebar**: Select a page to edit, create new pages, and manage the site structure. - -## Explore the editor - - - How branches and protection rules determine what happens when you publish, and how to manage the pull request review process. - - - - Leave feedback, ask questions, and discuss changes with your team. - - - - Propose changes that teammates can review, accept, or reject. - - - - Edit pages, search your content, modify settings, and configure your site from a chat interface. - - - - Add new and update existing pages. - - - - Reorder pages and manage site structure. - - - - Preview your site in real time as you edit without waiting for a build. - - - - Configure your site's branding, colors, and features. - - - - Configure AI instructions and publishing defaults for your deployment. - - - - Understand the Git concepts behind the editor: branches, commits, pull requests, and merges. - - - - Save time with keyboard shortcuts. - +* **Top bar**: Use the top bar to control what branch you work on, access the agent, preview, and publish changes. +* **Sidebar**: Use the sidebar to select pages to edit, create new pages, and manage your site structure. + * **Home**: The file tree for your project. Pages in **Personal** are private to you. Pages in **Workspace** are public to your organization. + * **Publishing**: The navigation structure for your site. Organize pages as you want them to appear in your site. + +## Visual and source mode + +**Visual mode** renders your page as you type. Press / to open the component menu and insert components. + +**Source mode** gives you direct access to the MDX. Use it for precise control over component properties and frontmatter. + +Both modes edit the same file. Switch between them with Cmd + Shift + S (macOS) or Ctrl + Shift + S (Windows). + +For the components you can insert, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code). + +## Git concepts + +Understanding some Git concepts helps you get the most from the editor. + + + + A saved snapshot of your changes at a point in time, with a message describing what changed. Publishing creates a commit. + + + A separate line of work. Your live site builds from a **deployment branch**, usually `main`. Other branches—sometimes called **feature branches**—let you work without affecting your live site. Nothing on a feature branch goes live until you merge it. + + + A proposal to merge one branch into another, so your team can review changes before they go live. Your team reviews and merges pull requests in GitHub, GitLab, or Bitbucket, or [from the editor](/editor/review). + + + Combining changes from one branch into another. Merging into your deployment branch publishes those changes. + + + Two branches with incompatible changes to the same lines. The editor prompts you to choose which version to keep in order to resolve conflicts before merging. + + + A comparison between two versions of a file. The editor shows a diff of your pending changes before you publish. + + + +| Action in the editor | Git operation | +|---|---| +| Edit a page | Saves automatically. No commit yet. | +| Publish on your deployment branch | `git commit` and `git push`. Triggers a deployment. | +| Save in branch | `git commit` to the current feature branch. | +| Create pull request | `git push` and opens a pull request against your deployment branch. | +| Merge and publish | Merges the pull request and triggers a deployment. | +| Create a branch | `git checkout -b ` | +| Switch branches | `git checkout ` | +| External push or CLI update | Incoming changes sync into the editor using a three-way merge. | diff --git a/editor/keyboard-shortcuts.mdx b/editor/keyboard-shortcuts.mdx index f5dcf76f5b..4d05cb5ff1 100644 --- a/editor/keyboard-shortcuts.mdx +++ b/editor/keyboard-shortcuts.mdx @@ -15,9 +15,7 @@ These shortcuts work regardless of which mode you're in. | **Search files and content** | Cmd + K | Ctrl + K | | **Toggle AI assistant** (when not editing text) | Cmd + I | Ctrl + I | | **Switch between visual and source mode** | Cmd + Shift + S | Ctrl + Shift + S | -| **Toggle diff view** | Cmd + Shift + D | Ctrl + Shift + D | -| **Switch between Navigation and Files tree** | Cmd + Shift + F | Ctrl + Shift + F | -| **Hide/show sidebar** | Cmd + \\ | Ctrl + \\ | +| **Show all files** (including dotfiles and non-content files) | Cmd + Shift + . | Ctrl + Shift + . | ## Visual mode @@ -44,6 +42,8 @@ Use these shortcuts when editing in visual mode. | **Heading 2** | Cmd + Option + 2 | Ctrl + Alt + 2 | | **Heading 3** | Cmd + Option + 3 | Ctrl + Alt + 3 | | **Heading 4** | Cmd + Option + 4 | Ctrl + Alt + 4 | +| **Heading 5** | Cmd + Option + 5 | Ctrl + Alt + 5 | +| **Heading 6** | Cmd + Option + 6 | Ctrl + Alt + 6 | ### Lists and blocks @@ -78,7 +78,7 @@ The editor automatically converts certain character sequences into typographic s ## Source mode -Source mode uses the Monaco editor, which supports standard VS Code keyboard shortcuts. +Source mode uses CodeMirror. Most common code editor shortcuts work, along with the ones below. ### Search and navigation @@ -91,7 +91,11 @@ Source mode uses the Monaco editor, which supports standard VS Code keyboard sho | Command | macOS | Windows | | :--- | :--- | :--- | +| **Bold** (wraps in `**`) | Cmd + B | Ctrl + B | +| **Italic** (wraps in `_`) | Cmd + I | Ctrl + I | | **Toggle comment** | Cmd + / | Ctrl + / | +| **Fold all** | Cmd + Option + Shift + [ | Ctrl + Alt + Shift + [ | +| **Unfold all** | Cmd + Option + Shift + ] | Ctrl + Alt + Shift + ] | | **Indent line** | Tab | Tab | | **Outdent line** | Shift + Tab | Shift + Tab | | **Move line up** | Option + ↑ | Alt + ↑ | diff --git a/editor/live-preview.mdx b/editor/live-preview.mdx deleted file mode 100644 index 1f9edfafb5..0000000000 --- a/editor/live-preview.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "Live preview" -description: "Preview your site in real time as you edit, with continuous updates that render content, navigation, and configuration changes instantly." -keywords: ["editor", "preview", "live preview"] ---- - -Preview your site while you edit. Live previews render pages exactly as they look when published, and update as you make changes to content, navigation, and configuration. - -## Open live preview - -Click the live preview button in the top bar. - - - The live preview button in the toolbar. - The live preview button in the toolbar. - - -## Edit site settings in live preview - -Edit your site settings in the live preview to see how they affect the rendered content. - -1. Open the live preview in the editor. -2. Click **Site settings** in the preview toolbar. -3. Select a configuration section and edit the settings. - -If you set the live preview to open in a new tab, the preview site settings menu is unavailable. Disable **Open live preview in new tab** in [editor settings](/editor/settings) to use the site settings menu. - -## Ask the agent in live preview - -Click **Ask agent** in the preview toolbar to open the [editor agent](/editor/agent) beside the live preview. Only editors and admins can use the agent in live previews. - - - Live preview works for public sites and sites protected by Mintlify authentication. - - -## Live preview versus preview deployments - -| | Live preview | Preview deployment | -|---|---|---| -| **Speed** | Instant | Requires a build | -| **Access** | Local URL | Shareable URL | -| **Use when** | Reviewing changes while editing | Sharing with your team for review | -| **Availability** | While the editor is open | As long as the branch exists | - -Use live preview for immediate feedback while editing. When you need to share changes with your team or test on a different device, use a [preview deployment](/editor/branching-and-publishing#preview-your-changes). diff --git a/editor/navigation.mdx b/editor/navigation.mdx deleted file mode 100644 index 450e1bbbba..0000000000 --- a/editor/navigation.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Organize navigation" -description: "Reorder pages, add groups, and manage your documentation sidebar structure using drag-and-drop in the Mintlify web editor—no docs.json edits needed." -keywords: ["editor", "navigation", "sidebar", "structure"] ---- - -Use the navigation sidebar to organize your documentation. The editor syncs your changes to your repository when you publish. You don't need to edit `docs.json` manually. - -## Add navigation elements - -Click **Add new** at the bottom of the navigation tree to add a new element at the root level. To nest an element inside another, click the plus button next to that element. - -Drag and drop elements to reorder or nest them. Hover over an element and click the gear icon to configure its properties. - -Right-click a **page** to open its settings or delete it. - -Right-click a **navigation element** to open its settings or convert it to a different element type. You can also duplicate it, add a page or group inside it, ungroup it, or delete it. - - - Some elements cannot nest inside other elements. For example, tabs cannot nest inside groups. The editor prevents you from creating invalid combinations. - - -## Navigation elements - -Choose the right structure for your content: - -- **Pages**—Individual documentation files. The core building block of navigation. -- **Groups**—Collapsible sections that cluster related pages together. Can nest within other groups. -- **Tabs**—Top-level sections with horizontal navigation at the top of your site. Use tabs when you have distinct areas like API Reference and Guides. -- **Anchors**—Persistent items at the top of your sidebar. Useful for quick access to external resources or top-level sections. Can be global to appear on every page. -- **Dropdowns**—Expandable menus at the top of your sidebar. A lighter alternative to tabs for multiple related sections. -- **Menus**—Dropdown navigation items within a tab for direct links to specific pages. -- **Products**—A switcher for multiple distinct product documentation sets, each with its own navigation structure. -- **Versions**—A switcher for multiple simultaneous documentation versions. -- **Languages**—A switcher for documentation in multiple languages. - -## Configure elements - -Hover over any navigation element and click the gear icon to set: - -- **Title**: The label shown in the sidebar. -- **Icon**: A visual marker next to the label. -- **Tag**: A badge like "NEW" or "BETA" to highlight the item. - diff --git a/editor/pages.mdx b/editor/pages.mdx index cd40b1fa88..9be78797f2 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -1,172 +1,70 @@ --- title: "Create and edit pages" -description: "Create pages, edit content, upload images and video, and manage files in the Mintlify web editor with rich-text editing and search across your content." -keywords: ["editor", "content", "pages", "files", "create", "edit", "version history", "media", "images", "video", "task lists", "private pages"] +sidebarTitle: "Edit content" +description: "Create pages, edit content, add media, organize your navigation, and recover earlier versions of a page in the editor." +keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages"] --- -## Navigate files +## Home and Publishing -The left panel has two views: **Navigation** and **Files**. +The editor workspace is split into two tabs: **Home** and **Publishing**. -**Navigation** shows your sidebar structure as visitors see it. Click a page to open it. +**Home** is your workspace. It shows the content files in your repository, including your private pages, whether or not they appear on your published site. -**Files** shows the full file tree of your repository, including files that aren't in your navigation. Click any file to open it. +**Publishing** is your published site. It shows the navigation your visitors see, along with your site settings. -To switch between views, click the file icon or press Cmd + Shift + F (macOS) or Ctrl + Shift + F (Windows). To search by filename or page content, click the search icon or press Cmd + K (macOS) or Ctrl + K (Windows). +Home hides some files by default including `docs.json`, files and folders whose names start with a dot, files with no extension, all-caps Markdown files like `README.md`, and `.css`, `.js`, `.jsx`, `.mjs`, `.cjs`, and `.pdf` files. To see all files, turn on [Show all files](/editor/settings#appearance) or press Cmd + Shift + . (macOS) or Ctrl + Shift + . (Windows). -## Manage files and folders +## Create a page -Use the Files view to organize your content: +To add a page to your navigation, click the plus button on the navigation element where you want it. Enter a name for your page. The editor adds the `.mdx` extension for you. -- **Create a folder**: Click the new folder button at the top of the file tree, or right-click an existing folder and select **New folder**. -- **Rename a file or folder**: Right-click the item and select **Rename**. -- **Open unlisted files**: Click any file in the tree to open it, even if it isn't included in your navigation. - -Files that aren't in your navigation remain unlisted. They exist in your repository but won't appear in the published sidebar. - -## Create new pages - -### Add a page to navigation - -1. Click the plus button in the navigation element where you want to add a page. -1. Click **Add a page**. -1. Enter a filename. The editor adds the `.mdx` extension automatically. - -### Create an unlisted page - -Unlisted pages exist in your repository but don't appear in navigation. They're useful for draft content, reusable snippets, or pages you plan to add to navigation later. - -Right-click any folder in the Files view and select **New file**. Enter a filename and the editor creates the page without adding it to navigation. You can add it to navigation later from the **Navigation** tab. - -## Edit content - -Switch between visual and source mode using the mode toggle in the toolbar below the top bar. To switch to visual mode, click the eye icon or press Cmd + Shift + S (macOS) or Ctrl + Shift + S (Windows). To switch to source mode, click the code icon or press the same shortcut. - -**Visual mode** shows a real-time preview as you type. Press / to open the component menu and insert components, images, videos, and other content. You can also drag and drop media files directly onto the page from your computer or from the navigation tree. Other shortcuts: - -- **Insert a link**: Select text and press Cmd + K (macOS) or Ctrl + K (Windows). You can also drag a page from the navigation tree into the editor to create a link with the page title. -- **Link to another page**: Right-click a page in the navigation tree, click **Copy link**, then paste the link into your content. The editor recognizes internal links to other pages and converts them. -- **Insert media from your project**: Drag an image or video from the navigation tree into the page to embed it inline. Supported formats include PNG, JPG, JPEG, GIF, WebP, SVG, MP4, and WebM. -- **Insert an emoji**: Type : followed by a keyword to open the emoji picker. -- **Edit a table**: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells. - -**Source mode** gives you direct access to the MDX source. Use it for precise control over component properties and frontmatter. - -For a full list of components, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code). - -### Task lists - -In visual mode, type `/task` and select **Task List** to add an interactive checklist. You can also type `- [ ]` followed by a space to turn a list item into a task. Click the checkbox beside a task to mark it complete. - -Press Enter at the end of a task to add another unchecked task. Press Enter again on an empty task to exit the list. - -In source mode, use `- [ ]` for an incomplete task or `- [x]` for a completed task. - -### Diff view - -To compare your current page against the last published version, click the **View diff** button in the toolbar, or press Cmd + Shift + D (macOS) or Ctrl + Shift + D (Windows). In visual mode, this shows a visual diff. In source mode, it shows a text diff. Click **Exit diff** or press the shortcut again to return to editing. - -You can also open a diff from the publish menu. Click **Publish** then click any changed file in the list. - -### Version history - -Use version history to review saved versions of the page you edit. Version history isn't available for `docs.json` files. - -The version history groups entries by date. Each entry shows the author and save time. The editor marks the most recent entry as **Current**. - -The editor records a new entry when content differs from the latest recorded version. If you save unchanged content, the editor doesn't create a duplicate entry. - -To open version history: - -1. Open a page in the editor. -1. Click **More options** in the top-right corner of the page. -1. Click **Version history**. - -If you enable version history for pages, you can click the **Edited** timestamp on the page to open version history. - -Public page history only includes the current branch. Private page history includes entries across branches. Click **Show more versions** to load older entries. - -Older versions include a **Restore** action when you have permission to edit the page. If you restore an older version, you overwrite any unsaved changes. Viewers can review and compare saved versions of private pages. Editors and managers can restore them. +## Add media -For public pages, the editor restores the page on your current branch. For private pages, it updates the shared private content. +Type /image or /video to upload a file or pick one already in your repository. You can also drag files from your computer onto the page. To reuse media, drag an image or video from the navigation tree onto a page. -To compare an older saved version with the current page, click its row. The editor opens diff view with the older version as the baseline and the current page content as the comparison. To exit comparison and return to editing, click the active row again. +- Uploads save to your `images/` and `videos/` folders and commit with your next publish. +- Supported formats are PNG, JPG, JPEG, GIF, WebP, SVG, MP4, and WebM. +- To serve different images in light and dark mode, hover an inserted image and use **Light/dark variants**. +- Type /embed and paste a YouTube, Loom, or Vimeo URL to generate the iframe. For anything else, toggle **Manual embed** to write custom HTML. -### Block actions +For formatting images and using the Frame component, see [Images and embeds](/create/image-embeds). -In visual mode, hover over any block to reveal a drag handle on the left. Click the handle to open a context menu with actions for that block: +## Organize navigation -- **Turn into**: Convert the block to a different type: text, headings, blockquote, or list. -- **Duplicate**: Insert a copy of the block immediately after it. -- **Delete**: Remove the block. +Drag elements in the Navigation view to reorder or nest them. The editor writes your changes to `docs.json` when you publish. - - The block actions menu in visual mode. - The block actions menu in visual mode. - +- **Groups**: Collapsible sections that cluster related pages. Can nest inside other groups. +- **Tabs**: Top-level sections with horizontal navigation. Use these for distinct areas like API reference and guides. +- **Anchors**: Persistent items at the top of your sidebar. Useful for external resources. Can be global, appearing on every page. +- **Dropdowns**: Expandable menus at the top of your sidebar. A lighter alternative to tabs. +- **Menus**: Dropdown items within a tab that link directly to specific pages. +- **Products**: A switcher for multiple product documentation sets, each with its own navigation. +- **Versions**: A switcher for multiple simultaneous documentation versions. +- **Languages**: A switcher for documentation in multiple languages. -### Table of contents + + Some elements can't nest inside others. Tabs can't nest inside groups, for example. The editor prevents invalid combinations. + -In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Click any heading to scroll to that section. +To change a page's title, slug, description, or layout, open its settings from the navigation tree. See [Pages](/organize/pages) for more information on specific settings. -### Code block options +## Version history -When editing a code block in visual mode, you can: +Version history lets you review and restore earlier saved versions of a page. It isn't available for `docs.json`. -- **Highlight or focus lines**: Select text within the code block, then use the toolbar that appears to mark lines as highlighted or focused. Highlighting visually emphasizes lines. Focusing lines dims everything else. -- **Mark diff lines**: Select lines and use the toolbar to mark them as additions (`+`) or removals (`-`). -- **Wrap**: Toggle line wrapping in the code block settings. -- **Expandable**: Make the code block collapsible so readers can expand it on demand. +Viewers can review and compare saved versions of private pages. Editors and admins can restore them. -## Manage pages +The editor records a new entry whenever content differs from the latest recorded version. Version history is branch-scoped. Only the current branch's version history is available. -- **Move**: Drag and drop pages to reorder them in navigation. -- **Rename**: Right-click a page and select **Rename**. -- **Duplicate**: Right-click a page and select **Duplicate**. -- **Delete**: Right-click a page and select **Delete**. The editor removes the page from navigation automatically. +To view version history, click **More options** in the top-right of the page, then click **Version history**. -### Move private pages to the workspace +If you restore a version, it overwrites any unsaved changes you made to the page. When you restore a public page, it is only restored on your current branch. When you restore a private page, it is restored on all branches. -To turn a private page or folder into workspace content, drag the private content from the **Private** section to a folder in your workspace. You can also right-click the private content and select **Move to workspace**. +## Private pages -When you move a private folder, all pages in the folder move to your workspace. Any content you move to your workspace immediately becomes available to your workspace collaborators, but it is not added to your site navigation. +Dragging a private page or folder into your workspace makes it available to your collaborators immediately, though it is not added to your site navigation. - You can't move workspace content back to the **Private** section. + You can't move workspace content back to the **Private** section. Making a private page public is a one-way change. - -### Pages deleted via Git - -If a teammate deletes a page through Git while you have it open, the editor enters read-only mode and shows a banner. The editor preserves your content so you can copy it before navigating away. - -## Configure pages - -Hover over a page and click the gear icon, or right-click and select **Settings**, to configure: - -- **Title**, **Slug**, and **Sidebar title**: Control how the page appears in navigation and its URL. -- **Description** and **Keywords**: Improve search and SEO. -- **Layout**: Choose from standard, wide, centered, or custom. - -For details on each setting, see [Pages](/organize/pages). - -## Add media - -### Images and videos - -Type /image to upload a new image or select an existing one from your repository. Type /video to upload or select a video. - -You can also drag and drop files from your computer directly onto a page. In visual mode, the file inserts inline. In source mode, the editor inserts the file path at your cursor position. Images save to your `images/` folder and videos to `videos/`. - -To reuse media that already lives in your project, drag an image or video file from the navigation tree onto the page. The editor embeds the asset inline. - -### Light and dark image variants - -After inserting an image in visual mode, hover over it to reveal the image toolbar. Use **Light/dark variants** to upload separate images for light and dark mode. - -### Embed external media - -Type /embed and paste a YouTube, Loom, or Vimeo URL. The editor detects the provider and generates the iframe. Searching the slash menu for `youtube`, `yt`, `loom`, or `vimeo` also surfaces the **Embed** command. - -For other embeds, type /embed and toggle **Manual embed** to write custom HTML. - -For more on formatting images and using the Frame component, see [Images and embeds](/create/image-embeds). diff --git a/editor/publish.mdx b/editor/publish.mdx new file mode 100644 index 0000000000..b287755ebd --- /dev/null +++ b/editor/publish.mdx @@ -0,0 +1,72 @@ +--- +title: "Publish changes" +sidebarTitle: "Publish" +description: "Publish changes from the editor to your live site. Branches and protection rules determine what happens when you publish." +keywords: ["publish", "branch", "git", "commit", "conflicts", "deploy", "pull request"] +--- + +Your changes save automatically as you edit, but they only reach your live site when you publish them. What happens when you publish depends on which branch you work on and whether that branch requires pull requests. + + + If you don't see a branch selector or a **Publish** button, your deployment has [auto publish](#auto-publish) turned on and your edits go live automatically. + + +## Pending changes + +The editor tracks the following as pending changes: + +- Content edits in pages +- New or deleted pages +- Navigation structure changes +- Media uploads +- Configuration updates + +If there are no pending changes, the editor disables the publish and save actions. + +## What happens when you publish + +| Branch type | Branch protection | Available actions | +| --- | --- | --- | +| Deployment branch | None | **Publish** directly to your live site | +| Deployment branch | Pull requests required | **Create branch** to move changes to a new branch | +| Feature branch | None | **Save in branch**, **Create pull request** | +| Feature branch | Pull requests required | **Save in branch**, **Create pull request** | + +- **Publish**: Commits and deploys your changes to your live site immediately. +- **Save in branch**: Commits your changes to the feature branch without merging to your deployment branch. +- **Create branch**: Moves your pending changes to a new feature branch when you're on a protected deployment branch. +- **Create pull request**: Opens a pull request targeting your deployment branch. + +Only one publish can happen at a time per branch. If a teammate publishes to the same branch, wait for their publish to complete before trying again. + + + Your live site updates after Mintlify builds and deploys your changes. This typically takes 30 seconds to a few minutes. Check the deployment status on your [dashboard](https://app.mintlify.com). + + +## When to use a branch + +Edit directly on your deployment branch if you do not use a Git-based workflow. Create a branch if each change goes through review before it reaches your live site. + +To create a branch, click the branch name in the editor toolbar, select **Create new branch**, enter a name, then click **Create branch**. + + + Creating or switching branches while you have unpublished changes prompts you to bring those changes with you or leave them behind. Changes you leave behind stay on the original branch. + + +## Resolve conflicts + +Conflicts occur when your branch and the deployment branch have incompatible changes to the same files. For example, when you and a teammate edit the same lines or move a file to different locations. + +When someone pushes to your repository from outside the editor, the editor applies non-overlapping changes automatically. If a remote change and your edit affect the same part of a page, the editor highlights the conflict. + +The editor displays a warning when conflicts block publishing. Follow the prompts to choose which version of each conflicting section to keep. + +## Commit signing + +Sign commits with your GitHub account by authorizing it in your [account settings](https://app.mintlify.com/settings/account). Without authorization, the Mintlify GitHub App signs commits made in the editor. + +## Auto publish + +If your deployment has [auto publish](/editor/settings#main-branch-autocommits) turned on, the editor commits to your deployment branch shortly after you stop typing. The branch selector and **Publish** button are hidden. There is no pending state and no review step. + +Edits on feature branches created from the editor commit automatically either way, but they never publish unless you merge them into your deployment branch. diff --git a/editor/review.mdx b/editor/review.mdx new file mode 100644 index 0000000000..7406a21740 --- /dev/null +++ b/editor/review.mdx @@ -0,0 +1,82 @@ +--- +title: "Review changes" +sidebarTitle: "Review" +description: "Preview changes before they go live, share them with your team, and approve and merge pull requests from the editor." +keywords: ["review", "preview", "live preview", "pull request", "approve", "merge", "diff"] +--- + +Preview your changes before they reach your live site, then review and merge the pull request without leaving the editor. + +## Live preview + +Live preview renders your site as you edit, with no build step. Click the live preview button in the top bar. + +To edit site settings and see how they affect your content, click **Site settings** in the preview toolbar, then select a configuration section. This menu is unavailable if you have [Open live preview in new tab](/editor/settings#appearance) enabled. + +To open the [agent](/editor/agent) beside the preview, click **Ask agent** in the preview toolbar. Only editors and admins can use the agent in live previews. + + + Live preview is only available for public sites and sites protected by Mintlify authentication. + + +## Preview deployments + +When you open a pull request from a feature branch, Mintlify builds a preview deployment: a temporary URL where your changes render exactly as they look when published. The preview rebuilds each time you save new changes to the branch. The URL format is `organization-branch-name.mintlify.site`. + +Preview URLs are publicly accessible by default. To restrict access to members of your Mintlify organization, enable preview authentication on the [Add-ons](https://app.mintlify.com/products/addons) page of your dashboard. + +## Which preview to use + +| Feature | Live preview | Preview deployment | +|---|---|---| +| **Speed** | Instant | Requires a build | +| **Access** | Local URL | Shareable URL | +| **Use when** | Reviewing changes while editing | Sharing with your team for review | +| **Availability** | While the editor is open | As long as the branch exists | + +## Share an editor link + +To point a teammate at a specific page on a branch, copy the URL from your browser's address bar. Anyone with access to your Mintlify organization can open it in their own editor session. + +```text +https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath} +``` + +For example: `https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx` + +## Review and merge pull requests + +When a pull request is open for the current branch, the publish menu shows a review panel with the number of changed files and current review status. + +After a reviewer approves, click **Merge and publish** to merge and deploy from the editor. The editor switches you back to your deployment branch after merging. + +### Approve from the editor + +For GitHub repositories, reviewers can approve open pull requests without leaving the editor. An **Approve pull request** button appears in the review panel if your account has permission to review it. The status updates to **Approved** and **Merge and publish** becomes available. + +If you use GitLab or Bitbucket, open the pull request in your Git provider to approve it. + + + Configure branch protection rules in your Git provider to require pull requests. See [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) in the GitHub help or [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) in the GitLab help. + + +### Compare changes before merging + +Click any changed file in the publish menu to open it in diff view against the published version. Visual mode shows a visual diff and source mode shows a text diff. Files that can't display a diff, such as images or deleted files, appear in the list but aren't clickable. + +[Hidden pages](/organize/hidden-pages) that appear in the branch diff are openable from the publish menu, even though they don't appear in your site navigation. + +### Pull request titles and descriptions + +If your organization requires pull requests, you can enter a title and description when you publish. If you leave either blank, the editor generates one listing the files you created, updated, moved, or deleted. To control how those are written, set [PR instructions](/editor/settings#pr-instructions). + +If your branch has open comment threads, Mintlify adds a summary of them to the pull request description. See [Collaborate](/editor/collaborate#comments). + +## Review an automation run + +When an [automation](/automations) opens a pull request, you can open the editor on the automation's branch: + +- From the **Automation Runs** page in your dashboard, click **Open in editor** on a completed run. +- From a Slack notification, click the **View changes** link. + +Either entry point opens the editor on the automation's branch with the changed pages preselected in the publish menu, so you can review the diff and merge or request changes without leaving the editor. The [agent](/editor/agent#continue-an-automation-run) opens alongside it with context on what the automation did. diff --git a/editor/settings.mdx b/editor/settings.mdx index 63bda28d58..4a590e6da8 100644 --- a/editor/settings.mdx +++ b/editor/settings.mdx @@ -1,73 +1,22 @@ --- title: "Editor settings for AI and publishing" -description: "Configure AI instructions, pull request defaults, and the default merge method to control how the Mintlify web editor publishes changes." -keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "lock branch"] +sidebarTitle: "Settings" +description: "Configure editor appearance, AI instructions, and publishing defaults to control how the Mintlify web editor looks and how it commits and merges changes." +keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "appearance", "preferences"] --- -The web editor has two layers of settings: +The editor [settings page](https://app.mintlify.com/settings/deployment/editor) controls the appearance, publishing behavior, and agent behavior. -- **Your settings** apply only to you and control how the editor's AI assists with your edits. -- **Publishing settings** apply to everyone on a deployment and shape what happens when you commit changes and turn them into pull requests. +- **Appearance**: Personal preferences for how the editor looks and behaves. These apply only to you. +- **Publishing**: Deployment-wide defaults for how the editor commits changes and opens pull requests. These apply to everyone who publishes. +- **Chat**: Persistent instructions for the editor's AI agent. +- **Danger zone**: Actions that can't be undone. -You can configure both from the settings panel. To open it, click the settings icon in the editor toolbar. +## PR instructions -## AI instructions - -AI instructions are persistent guidance that the editor sends to the AI alongside your request. Use them to capture style and tone rules you don't want to repeat every time, like voice, terminology, or formatting conventions. - -Your instructions apply to: - -- **Edit with AI** actions on a selection, such as rewrite, expand, or fix. -- **Agent sessions** started from the editor. - -Each teammate maintains their own instructions, scoped to their user account. - -### When to use AI instructions - -Add AI instructions when you find yourself repeating the same guidance in prompts, for example: - -- Enforcing second-person voice or sentence case headings. -- Preferring specific product names or terminology. -- Banning marketing language or filler phrases. -- Requiring certain components, like always using `` for callouts. - -Keep instructions short and specific. The AI follows them on every request, so vague or contradictory rules degrade results. - -### Configure AI instructions - -1. Click the settings icon in the editor toolbar. -2. In the **AI instructions** field, enter the guidance you want the AI to follow. -3. Save your changes. - -Example: - -```text -- Use second person ("you") and active voice. -- Use sentence case for all headings. -- Refer to the product as "Acme" — never "Acme Inc." or "the platform". -- Wrap notes and warnings in or components. -- Do not add introductory filler like "In this guide" or "Let's explore". -``` - -Leave the field empty to remove your instructions. - -## Publishing settings - -You configure publishing settings per deployment, and they apply to everyone who publishes from the editor. They control how the editor generates, opens, and merges pull requests and commits. - -You need admin access to your Mintlify deployment to change publishing settings. - -### Lock the deployment branch - -To make your deployment branch (usually `main`) read-only in the editor, lock the deployment branch. - -Use this setting when your team wants all editor changes to create pull requests from feature branches. +PR instructions guide the AI when it generates a pull request title and description. They apply whenever the editor opens a pull request on your behalf, including from **Create pull request** and **Merge and publish** flows. -### Pull request instructions - -Pull request instructions guide the AI when it generates a pull request title and description. They apply whenever the editor opens a pull request on your behalf, including from **Create pull request** and **Merge and publish** flows. - -Use pull request instructions to standardize what reviewers see, for example: +Use PR instructions to standardize what reviewers see, for example: - Required sections like **Summary** and **Changes**. - A description template that links to a tracking system. @@ -82,58 +31,66 @@ Description: include a "## Summary" section (one sentence) and a using its relative path. ``` -### Main branch autocommits - -When you enable main branch autocommits, the editor commits changes shortly after you stop typing. - -Use this setting when your team edits the deployment branch directly and wants updates to reach Git without a manual publish step. If you want to review changes before they publish to your site, do not use autocommits. - -Edits on feature branches created from the editor autocommit regardless of this setting. Changes on a feature branch never publish unless you merge them into your deployment branch. +Instructions are limited to 20,000 characters. -### Create pull requests as drafts by default +## Main branch autocommits -Turn this on to have the editor open every new pull request in draft state. You can't merge a draft pull request until you mark it ready for review. This is useful when: +Main branch autocommits push changes to your main branch automatically, shortly after you stop typing. If you enable this setting, the editor **hides branches and the publish step entirely**. Changes go live with no review. -- Your team requires a manual review pass before a pull request is open for approval. -- You want to share preview URLs without signaling that the change is ready to merge. - -You can still mark a pull request as ready for review from your Git provider. + + With main branch autocommits on, there is no pending state and no chance to review. Every edit reaches your live site shortly after you stop typing. + -### Default merge method +## PR merge method Choose how the editor merges pull requests when you click **Merge and publish**: -- **Merge**: Creates a merge commit that preserves the full branch history. +- **Merge**: Creates a merge commit that preserves the full branch history. This is the default. - **Squash**: Combines all commits in the branch into a single commit on your deployment branch. - **Rebase**: Replays each commit from the branch onto your deployment branch without a merge commit. -The editor uses the selected method by default. If you pass an explicit merge method through the API or your Git provider's UI, that choice takes precedence. +If you pass an explicit merge method through the API or your Git provider's UI, that choice takes precedence. - Match your default merge method to your Git provider's branch protection settings. If your deployment branch only allows squash merges, set the default to **Squash** to avoid failed merges from the editor. + Match your merge method to your Git provider's branch protection settings. If your deployment branch only allows squash merges, set the method to **Squash** to avoid failed merges from the editor. -## Danger zone +## AI instructions -The **Danger zone** section of the editor settings panel contains actions that can't be undone. Click the settings icon in the editor toolbar then scroll to **Danger zone**. +AI instructions are persistent guidance that the editor sends to the AI alongside your request. Use them to capture style and tone rules you don't want to repeat every time, like voice, terminology, or formatting conventions. -### Reset editor +Your instructions apply to: -**Reset editor** forces the editor to discard its local state and sync with your Git repository. If the editor gets stuck out of sync with your repo, reset the editor. Reset the editor if the file tree is empty or shows errors like `Unable to find docs.json`. This can happen even though the file exists on your deployment branch and your live site builds normally. +- **Edit with AI** actions on a selection, such as rewrite, expand, or fix. +- **Agent sessions** started from the editor. - - If you reset the editor, you discard any unpublished changes that you haven't committed to Git. If you have pending edits you want to keep, publish them first. - +Each teammate maintains their own instructions, scoped to their user account. Instructions are limited to 20,000 characters. -To reset the editor: +Add AI instructions when you find yourself repeating the same guidance in prompts, for example: -1. Click the settings icon in the editor toolbar. -2. Scroll to **Danger zone**. -3. Click **Reset editor** and confirm. +- Enforcing second-person voice or sentence case headings. +- Preferring specific product names or terminology. +- Banning marketing language or filler phrases. +- Requiring certain components, like always using `` for callouts. + +Keep instructions short and specific. The AI follows them on every request, so vague or contradictory rules degrade results. + +Example: + +```text +- Use second person ("you") and active voice. +- Use sentence case for all headings. +- Refer to the product as "Acme"—never "Acme Inc." or "the platform". +- Wrap notes and warnings in or components. +- Do not add introductory filler like "In this guide" or "Let's explore". +``` -The editor reloads and pulls the latest state from your repository. +Leave the field empty to remove your instructions. -## Related +## Reset editor -- [Branching and publishing](/editor/branching-and-publishing) -- [Configurations](/editor/configurations) +**Reset editor** forces the editor to discard its local state and sync with your Git repository. Reset the editor if it gets stuck out of sync with your repo, for example if the file tree is empty or shows errors like `Unable to find docs.json`. This can happen even though the file exists on your deployment branch and your live site builds normally. + + + If you reset the editor, you discard any unpublished changes that you haven't committed to Git. If you have pending edits you want to keep, publish them first. + diff --git a/editor/suggestions.mdx b/editor/suggestions.mdx deleted file mode 100644 index cf23291f1a..0000000000 --- a/editor/suggestions.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "Suggest changes in the editor" -sidebarTitle: "Suggestions" -description: "Propose text changes as suggestions that teammates can review, accept, or reject in the editor without modifying the current page content." -keywords: ["suggestions", "suggesting", "collaboration", "review"] ---- - -Suggestions let you propose changes to text while preserving the current content. Teammates can review, accept, or reject your suggestions. - -Suggesting mode applies to page text. Editors and admins can accept or reject any suggestion, but viewers cannot. See [roles](/dashboard/roles) for details. - -Pending suggestions appear as highlighted text in the editor. The sidebar lists them alongside comments so reviewers can find them. - -## Make suggestions - -1. Highlight any text on the page. -2. Click the **Switch to Suggesting** button in the toolbar. -3. In suggesting mode, edit any text. Deletions and insertions appear with highlighting so that reviewers can identify the changes you propose. -4. To exit suggesting mode, click the **Switch to Editing** button in the floating toolbar or the **X** on the **Suggesting** pill in the top bar. - - - [Viewers](/dashboard/roles) are always in suggesting mode. Suggesting mode activates automatically when a viewer opens the editor. The **Suggesting** pill is visible but not interactive for viewers, so they remain in suggesting mode. This lets viewers propose changes without directly editing content. - - - - The switch to suggesting button in the floating toolbar above selected text in the editor. - The switch to suggesting button in the floating toolbar above selected text in the editor. - - -## Accept a suggestion - -1. Click the highlighted suggestion text. -2. Click the **Accept** button to apply the suggested change. - -Accepting a suggestion resolves and deletes the suggestion thread. The accepted change becomes part of your current branch and goes live the next time you [publish](/editor/branching-and-publishing). - -## Reject a suggestion - -1. Click the highlighted suggestion text. -2. Click the **Reject** button to discard the proposed change. - -Rejecting a suggestion resolves and deletes the suggestion thread. diff --git a/es.json b/es.json index 45df02e5f4..9e47d1de13 100644 --- a/es.json +++ b/es.json @@ -99,15 +99,11 @@ "root": "es/editor/index", "pages": [ "es/editor/tutorial", - "es/editor/git-essentials", "es/editor/pages", - "es/editor/navigation", - "es/editor/live-preview", - "es/editor/branching-and-publishing", - "es/editor/comments", - "es/editor/suggestions", + "es/editor/publish", + "es/editor/review", + "es/editor/collaborate", "es/editor/agent", - "es/editor/configurations", "es/editor/settings", "es/editor/keyboard-shortcuts" ] diff --git a/es/changelog.mdx b/es/changelog.mdx index ba3a2b6143..02fb893cd2 100644 --- a/es/changelog.mdx +++ b/es/changelog.mdx @@ -11,7 +11,7 @@ noindex: true ## Editor y colaboración - - **Branches v2 e historial de versiones:** Las ramas del editor ahora se respaldan con pull requests en borrador y guardan automáticamente los cambios en Git. Puedes renombrar o eliminar ramas, descartar cambios guardados automáticamente y mover cambios pendientes a una rama nueva. El menú de ramas se ordena por actividad reciente, usa nombres por usuario y muestra nombres `Draft ` más claros para las ramas generadas automáticamente. Consulta [Ramas y publicación](/es/editor/branching-and-publishing). + - **Branches v2 e historial de versiones:** Las ramas del editor ahora se respaldan con pull requests en borrador y guardan automáticamente los cambios en Git. Puedes renombrar o eliminar ramas, descartar cambios guardados automáticamente y mover cambios pendientes a una rama nueva. El menú de ramas se ordena por actividad reciente, usa nombres por usuario y muestra nombres `Draft ` más claros para las ramas generadas automáticamente. Consulta [Ramas y publicación](/es/editor/publish). - **Navegación simplificada del editor:** El editor tiene una nueva fila de breadcrumbs, controles de página y uso compartido consolidados, encabezados de sección fijos en la barra lateral y una barra inferior dedicada a la configuración y **Ask agent**. En pantallas pequeñas, la navegación móvil ahora usa una barra superior simplificada y una barra lateral en forma de panel. - **Acceso a páginas y comentarios:** Solicita acceso de edición a una página privada o protegida desde el editor y revisa las solicitudes en un modal de aprobación. Las tarjetas de comentarios ahora muestran fotos de perfil y las @menciones enlazan al usuario mencionado. - **Mejoras de live preview:** Ejecuta varias vistas previas locales al mismo tiempo. Los cambios de navegación se propagan a las vistas previas abiertas, el panel del agente se acopla a la izquierda y la vista previa permanece visible durante los turnos de seguimiento del onboarding. @@ -179,7 +179,7 @@ noindex: true - **Flujo de revisión:** Solicita la revisión de un borrador, deja comentarios y aprueba o solicita cambios antes de publicar. Las revisiones ahora admiten ramas que no son de despliegue. - - **Más formas de colaborar:** Inicia [hilos de comentarios](/es/editor/comments) sobre una página completa, menciónate para dejar un recordatorio y usa los atajos de teclado Option + C u Option + S para comentar o sugerir cambios en el texto seleccionado. + - **Más formas de colaborar:** Inicia [hilos de comentarios](/es/editor/collaborate#comments) sobre una página completa, menciónate para dejar un recordatorio y usa los atajos de teclado Option + C u Option + S para comentar o sugerir cambios en el texto seleccionado. - **Edición más rápida y disponible:** El editor se renderiza sin esperar al árbol de archivos de Git y las personas sin acceso de escritura en GitHub pueden usarlo.
@@ -236,7 +236,7 @@ noindex: true ## Mejoras del editor
- - **Borradores:** Trabaja en cambios sin publicar sin crear una rama ni usar comandos de Git. Consulta [Borradores](/es/editor/branching-and-publishing) para obtener más información. + - **Borradores:** Trabaja en cambios sin publicar sin crear una rama ni usar comandos de Git. Consulta [Borradores](/es/editor/publish) para obtener más información. - **Bloquea la rama de despliegue:** El editor ahora te pide bloquear tu rama de despliegue si detecta protecciones de rama. - **[Agente del editor](/es/editor) más rápido con mejor función de deshacer/rehacer:** Las actualizaciones del agente ahora se transmiten al instante, la navegación es más rápida y los cambios de contenido y del árbol de navegación se pueden deshacer y rehacer de forma limpia. - **El estado de los encabezados plegables se mantiene por usuario:** Tus preferencias de secciones expandidas y colapsadas se conservan entre sesiones del editor. @@ -1071,7 +1071,7 @@ noindex: true - Se rediseñó la página de configuración del editor con un diseño mejorado y soporte de autoguardado. - Las páginas generadas automáticamente a partir de especificaciones OpenAPI ahora aparecen en el editor web como entradas de solo lectura. - - Soporte de video en la [vista previa en vivo](/es/editor/live-preview). Los archivos mp4, webm y mov incrustados ahora se renderizan correctamente durante el desarrollo local. + - Soporte de video en la [vista previa en vivo](/es/editor/review#live-preview). Los archivos mp4, webm y mov incrustados ahora se renderizan correctamente durante el desarrollo local. - Las [automatizaciones](/es/automations) ahora se pueden deshabilitar y volver a habilitar desde el dashboard. - Los análisis del asistente ahora muestran el uso desglosado por fuente (web vs API) en el dashboard. - La búsqueda MCP autenticada ahora filtra correctamente los resultados según los grupos de autenticación del usuario. @@ -1620,7 +1620,7 @@ Visualiza el feedback desglosado por páginas individuales en tu dashboard de [a ## Mejoras en el editor web - * Se añadieron [enlaces de vista previa compartibles](/es/editor/branching-and-publishing#access-and-share-a-preview) en la barra de herramientas del editor. + * Se añadieron [enlaces de vista previa compartibles](/es/editor/review#preview-deployments) en la barra de herramientas del editor. * Se actualizó el [flujo de publicación](/es/editor/publish) para permitir la publicación con un solo clic o la creación de solicitudes de extracción. * Trabajar en el editor web ya no requiere que inicies sesión con GitHub. diff --git a/es/deploy/authentication-setup.mdx b/es/deploy/authentication-setup.mdx index b88460193f..146c884bb6 100644 --- a/es/deploy/authentication-setup.mdx +++ b/es/deploy/authentication-setup.mdx @@ -581,4 +581,4 @@ Algunas funciones se comportan de manera diferente o no están disponibles cuand | [skill.md](/es/ai/skillmd) | Compatibilidad completa | No compatible | No compatible | | [Mapa del sitio](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación, pero excluye las páginas en groups | Disponible tras autenticación, pero excluye las páginas en groups | | [robots.txt](/es/optimize/seo#sitemaps-and-robotstxt-files) | Compatibilidad completa | Disponible tras autenticación | Disponible tras autenticación | -| [Vista previa en vivo](/es/editor/live-preview) | Compatibilidad completa | Compatible con autenticación automática del editor | Compatible con autenticación automática del editor | +| [Vista previa en vivo](/es/editor/review#live-preview) | Compatibilidad completa | Compatible con autenticación automática del editor | Compatible con autenticación automática del editor | diff --git a/es/editor/agent.mdx b/es/editor/agent.mdx index 055114df81..499a55ee14 100644 --- a/es/editor/agent.mdx +++ b/es/editor/agent.mdx @@ -1,12 +1,12 @@ --- title: "Preguntar al agente" -description: "Usa el agente de IA integrado del editor para escribir y editar páginas, dejar comentarios y sugerencias, buscar en el sitio y ajustar la configuración." +description: "Use el agente de IA integrado del editor para escribir contenido, editar páginas, dejar comentarios y sugerencias, buscar en su sitio, subir archivos y ajustar la configuración." keywords: ["editor", "AI", "assistant", "agent", "chat", "comments", "suggestions", "code mode", "file upload"] --- -El editor incluye un agente integrado que puede editar páginas, reorganizar la navegación, actualizar `docs.json`, buscar en todo su repositorio y gestionar la configuración del panel. +El editor incluye un agente integrado que puede editar páginas, reorganizar la navegación, actualizar `docs.json`, buscar en todo su repositorio y gestionar la configuración del dashboard. -El agente del editor realiza los cambios directamente en la branch actual. +El agente del editor realiza los cambios directamente en su branch actual.
@@ -14,21 +14,11 @@ El agente del editor realiza los cambios directamente en la branch actual.
-Haga clic en **Ask agent** en la barra de herramientas del editor, o presione Cmd + I (macOS) o Ctrl + I (Windows). +Haga clic en **Ask agent** en la barra de herramientas del editor o presione Cmd + I (macOS) o Ctrl + I (Windows). -Para cerrar el panel, haga clic en el botón **X** del encabezado del panel o vuelva a presionar Cmd + I. +Escriba @ para mencionar una página concreta y el agente se centrará en ella. Sin una mención, usa la página que tiene abierta. -
- -## Enviar un mensaje - -
- -Escriba su solicitud en el cuadro de chat en la parte inferior del panel y presione Enter o haga clic en el botón de envío . - -Escriba @ para mencionar una página específica. El agente se centra en esa página al procesar su solicitud. Si no menciona ninguna página, el agente utiliza la página que tiene abierta en ese momento. - -Ejemplos de prompts: +Prompts de ejemplo: - `simplify the introduction page` - `fix all grammar errors across my content` @@ -42,14 +32,14 @@ Ejemplos de prompts: -Haga clic en el icono del clip en el cuadro de chat, o arrastre y suelte archivos en el panel. El agente lee los archivos adjuntos como contexto para su solicitud. +Haga clic en el icono del clip en el cuadro de chat o arrastre y suelte archivos en el panel. El agente lee los archivos adjuntos como contexto para su solicitud. Tipos de archivo admitidos: - **Imágenes**: JPG, PNG, GIF, WebP, SVG - **Documentos**: PDF - **Código y texto**: `.js`, `.ts`, `.jsx`, `.tsx`, `.mdx`, `.md`, `.json`, `.yaml`, `.html`, `.css`, Python, Go, Rust, Ruby, Java, Swift, C, C++, SQL, scripts de shell y más -Tamaño máximo: 5 MB por archivo, excepto los archivos SVG, que están limitados a 256 KB. Máximo: 10 archivos por mensaje. +Tamaño máximo: 5 MB por archivo, salvo los archivos SVG, limitados a 256 KB. Máximo: 10 archivos por mensaje. Mintlify elimina los scripts y otro contenido activo de los archivos SVG antes de que el agente los lea. @@ -59,26 +49,26 @@ Mintlify elimina los scripts y otro contenido activo de los archivos SVG antes d -En modo visual, seleccione texto en una página. Aparece una barra de herramientas flotante sobre la selección. Haga clic en **Add to agent** para enviar el texto seleccionado al agente como contexto. +En el modo visual, seleccione un texto y haga clic en **Add to agent** en la barra de herramientas flotante para enviarlo al agente como contexto.
-## Solicitar comentarios y sugerencias +## Pedir comentarios y sugerencias
-De forma predeterminada, el agente edita el contenido directamente. Para obtener feedback sin cambiar la página de inmediato, pídale explícitamente al agente que revise la página, deje comentarios o haga sugerencias. +De forma predeterminada, el agente edita el contenido directamente. Para obtener opiniones sin cambiar la página de inmediato, pídale explícitamente que revise la página, deje comentarios o haga sugerencias. -- Las [sugerencias](/es/editor/suggestions) proponen un reemplazo específico que puede aceptar o rechazar. El texto original permanece visible tachado hasta que decida, y el agente puede incluir una explicación en el hilo de la sugerencia. -- Los [comentarios](/es/editor/comments) dejan feedback o una pregunta anclada a un texto específico sin cambiar la página. +- Las [sugerencias](/es/editor/collaborate#suggestions) proponen un reemplazo concreto que puede aceptar o rechazar. El texto original permanece visible tachado hasta que decida, y el agente puede incluir una explicación en el hilo de la sugerencia. +- Los [comentarios](/es/editor/collaborate#comments) dejan una opinión o una pregunta anclada a un texto concreto sin cambiar la página. -Ejemplos de prompts: +Prompts de ejemplo: - `review this page and leave suggestions` - `comment on anything that needs more context` - `suggest ways to make the introduction more concise` -El agente utiliza la página que tiene abierta en ese momento a menos que indique otra. Puede anotar el texto renderizado de la página, incluida la prosa dentro de los componentes, pero no el frontmatter, los metadatos de la página, la configuración ni las etiquetas y atributos crudos de los componentes MDX. +El agente usa la página que tiene abierta salvo que indique otra. Puede anotar el texto representado de la página, incluida la prosa dentro de los componentes. No puede anotar el frontmatter, los metadatos de la página, la configuración ni las etiquetas y atributos MDX en bruto.
@@ -86,11 +76,11 @@ El agente utiliza la página que tiene abierta en ese momento a menos que indiqu
-A medida que el agente edita sus páginas, aparece un panel **Changed files** en el chat. Expándalo para ver una lista de cada archivo modificado en la sesión. Haga clic en cualquier archivo para abrirlo en la vista de diff y comparar los cambios del agente con el original. +Aparece un panel **Changed files** en el chat mientras el agente trabaja. Despliéguelo para ver todos los archivos modificados en la sesión y haga clic en cualquiera para comparar los cambios con el original en la vista de diff.
-## Lo que el agente puede hacer +## Qué puede hacer el agente
@@ -100,7 +90,7 @@ A medida que el agente edita sus páginas, aparece un panel **Changed files** en -El agente puede escribir, reescribir, ampliar y reorganizar contenido en cualquier página. Lee su contenido existente para adaptarse a su estilo y estructura. +El agente puede escribir, reescribir, ampliar y reorganizar el contenido de cualquier página. Lee su contenido existente para adaptarse a su estilo y estructura.
@@ -108,25 +98,25 @@ El agente puede escribir, reescribir, ampliar y reorganizar contenido en cualqui
-El agente puede buscar en todo su repositorio, no solo en la página que tiene abierta. Úselo para encontrar información, comprobar inconsistencias o verificar que el contenido existe antes de añadirlo. +El agente puede buscar en todo su repositorio, no solo en la página que tiene abierta. Úselo para encontrar información, detectar incoherencias o comprobar que un contenido ya existe antes de añadirlo. -
+
### Actualizar la navegación y docs.json
-El agente puede añadir, renombrar, reordenar y eliminar elementos de navegación, los mismos cambios que haría manualmente en el panel de navegación. También puede actualizar la configuración de `docs.json` directamente, incluyendo añadir nuevos grupos, ajustar opciones y configurar redirecciones. +El agente puede añadir, renombrar, reordenar y eliminar elementos de navegación, los mismos cambios que haría manualmente en el panel de navegación. También puede actualizar la configuración de `docs.json` directamente, incluido añadir groups nuevos, ajustar opciones y configurar redirecciones. Ejemplo: `add a "Quickstart" group under the Getting Started tab and move the quickstart page into it`
-### Ejecutar comandos bash +### Ejecutar comandos de bash
-El agente puede ejecutar `grep`, `rg` y otros comandos bash sobre su repositorio. Úselo para operaciones masivas que abarquen muchos archivos. +El agente puede ejecutar `grep`, `rg` y otros comandos de bash sobre su repositorio. Úselo para operaciones masivas que abarcan muchos archivos. Ejemplo: `find every page that mentions the deprecated /v1/auth endpoint` @@ -136,11 +126,11 @@ Ejemplo: `find every page that mentions the deprecated /v1/auth endpoint`
-Para solicitudes que van más allá de editar páginas (configurar autenticación, gestionar workflows o cambiar ajustes de despliegue), el agente cambia a code mode. Escribe y ejecuta un script contra su panel de Mintlify en su nombre. +Para solicitudes que van más allá de editar páginas (configurar la autenticación, gestionar workflows o cambiar los ajustes del deployment), el agente pasa al code mode. Escribe y ejecuta un script contra su dashboard de Mintlify en su nombre. -Code mode respeta sus permisos del panel. Si no tiene acceso a un ajuste en el panel, el agente tampoco puede cambiarlo. +El code mode respeta sus permisos del dashboard. Si no tiene acceso a un ajuste en el dashboard, el agente tampoco puede cambiarlo. -Ejemplos de prompts que usan code mode: +Prompts de ejemplo que usan code mode: - `enable JWT authentication for my site` - `create a workflow that updates my site when I merge a PR` @@ -152,9 +142,9 @@ Ejemplos de prompts que usan code mode: -Cuando abres el editor desde una ejecución de automatización completada haciendo clic en **Ver cambios**, el panel del agente se abre automáticamente con contexto sobre lo que hizo la automatización. Una tarjeta de **Páginas modificadas** en la parte superior del chat lista cada página que la automatización modificó: haz clic en cualquier página para abrir una vista de diff. +Cuando abre el editor desde una ejecución de automatización completada haciendo clic en **View changes**, el panel del agente se abre automáticamente con contexto sobre lo que hizo la automatización. Una tarjeta **Changed pages** en la parte superior del chat enumera todas las páginas que modificó la automatización. Haga clic en cualquier página para abrir una vista de diff. -El agente tiene contexto sobre el prompt de la automatización, un resumen de los cambios que realizó y qué páginas modificó. Puedes pedirle que refine o amplíe el trabajo de la automatización sin tener que volver a explicar el contexto. +El agente dispone del prompt de la automatización, de un resumen de los cambios que hizo y de las páginas que modificó. Puede pedirle que refine o amplíe su trabajo sin volver a explicarle el contexto. Por ejemplo: `The new section on rate limits is too long. Trim it to three sentences.` @@ -164,7 +154,7 @@ Por ejemplo: `The new section on rate limits is too long. Trim it to three sente -Haga clic en el icono del reloj en el encabezado del panel para ver sus sesiones de chat anteriores. Haga clic en cualquier sesión para volver a abrirla y ver lo que cambió el agente. +Haga clic en el icono del reloj en el encabezado del panel para ver sus sesiones de chat anteriores. Haga clic en cualquier sesión para reabrirla y ver qué cambió el agente.
@@ -172,4 +162,4 @@ Haga clic en el icono del reloj en el encabezado del panel para ver sus sesiones
-Para dar al agente pautas persistentes como reglas de voz, terminología o convenciones de formato, configure las instrucciones de IA en la [configuración del editor](/es/editor/settings#ai-instructions). El agente sigue estas instrucciones en cada solicitud sin que tenga que repetirlas. +Para dar al agente directrices persistentes, como reglas de voz, terminología o convenciones de formato, configure las instrucciones de IA en la [configuración del editor](/es/editor/settings#ai-instructions). El agente sigue estas instrucciones en cada solicitud sin que tenga que repetirlas. diff --git a/es/editor/branching-and-publishing.mdx b/es/editor/branching-and-publishing.mdx deleted file mode 100644 index e1d097d1f8..0000000000 --- a/es/editor/branching-and-publishing.mdx +++ /dev/null @@ -1,264 +0,0 @@ ---- -title: "Branches y publicación" -description: "Comprenda cómo las branches y las reglas de protección determinan lo que sucede al publicar, y cómo gestionar el flujo completo de revisión y despliegue." -keywords: ["editor", "branch", "publish", "pull request", "preview", "git", "merge", "deploy"] ---- - -El editor web guarda todo automáticamente mientras escribe, pero sus cambios solo están en producción cuando decide publicarlos. - -Lo que sucede al publicar depende de dos cosas: **en qué branch se encuentre** y **si esa branch requiere pull requests**. - -
- -## Guardar frente a publicar - -
- -**Guardar** ocurre automáticamente. Mintlify almacena sus ediciones en sus servidores y las conserva entre pestañas del navegador, dispositivos e interrupciones de red. - -**Publicar** confirma sus cambios en su repositorio de Git. Haga clic en **Publish** en la barra de herramientas para abrir el menú de publicación, guardar sus cambios como un commit de Git y crear una pull request. - -El editor registra lo siguiente como cambios pendientes: - -- Ediciones de contenido en páginas -- Páginas nuevas o eliminadas -- Cambios en la estructura de navegación -- Cargas de medios -- Actualizaciones de configuración - -
- -## Lo que sucede al publicar - -
- -Las acciones disponibles al hacer clic en el botón de publicar dependen de la branch actual y de si tiene reglas de protección de branch que exigen pull requests. - -| Tipo de branch | Protección de branch | Acciones disponibles | -|-------------|-------------------|-------------------| -| Deployment branch | Ninguna | **Publish** directamente en su sitio en producción | -| Deployment branch | Se requieren pull requests | **Create branch** para mover los cambios a una nueva branch | -| Feature branch | Ninguna | **Save in branch**, **Create pull request** | -| Feature branch | Se requieren pull requests | **Save in branch**, **Create pull request** | - -- **Publish**: Confirma y despliega sus cambios en su sitio en producción de inmediato. -- **Save in branch**: Confirma sus cambios en la feature branch sin fusionarlos con su deployment branch. -- **Create branch**: Mueve sus cambios pendientes a una nueva feature branch cuando se encuentra en una deployment branch protegida. -- **Create pull request**: Abre una pull request dirigida a su deployment branch. - -Si no hay cambios pendientes, el editor desactiva las acciones de publicar y guardar. - - - Su sitio en producción se actualiza después de que Mintlify compile y despliegue sus cambios. Esto suele tardar de 30 segundos a unos pocos minutos. Compruebe el estado del despliegue en su [panel](https://app.mintlify.com). - - -
- -## Cuándo usar una branch - -
- -**Edite directamente en su deployment branch** si no utiliza un flujo de trabajo basado en Git. - -**Cree una branch** cuando utilice un flujo de trabajo basado en branches en el que realiza cada cambio en su contenido en una branch separada. - -
- -## Crear y cambiar de branch - -
- -
- -### Crear una branch - -
- -1. Haga clic en el nombre de la branch en la barra de herramientas del editor. -1. Haga clic en **Create new branch**. -1. Si tiene cambios pendientes, elija si llevarlos a la nueva branch o dejarlos en la branch actual. -1. Introduzca un nombre y haga clic en **Create branch**. - - - Use nombres descriptivos para las branches de modo que pueda identificarlas fácilmente y otras personas comprendan para qué sirve cada una. - - -
- -### Cambiar de branch - -
- -1. Haga clic en el nombre de la branch en la barra de herramientas. -1. Busque o desplácese hasta la branch que desee. -1. Haga clic en la branch para cambiar a ella. - - - Si cambia de branch cuando tiene cambios sin publicar, se le pedirá que lleve esos cambios a la nueva branch o que los deje atrás. Los cambios dejados atrás permanecen en su branch original. - - - - Para copiar el nombre de una branch, pase el cursor sobre la branch en el menú desplegable y haga clic en el icono de copiar. Esto resulta útil al compartir la branch con sus compañeros de equipo o al referenciarla en una pull request. - - -
- -## Previsualizar sus cambios - -
- -Cada vez que guarda cambios en una feature branch, Mintlify compila un despliegue de vista previa, una URL temporal donde sus cambios se renderizan exactamente como cuando se publican. - -
- -### Acceder y compartir una vista previa - -
- -1. Haga clic en **Publish** en la barra de herramientas del editor. -1. En el menú de publicación, haga clic en la URL de vista previa. El formato de la URL es `organization-branch-name.mintlify.site`. - - URL de vista previa destacada en el menú de publicación. - URL de vista previa destacada en el menú de publicación. - - -Copie la URL y envíela a los revisores. La vista previa se actualiza automáticamente cada vez que guarda en la branch. - -
- -### Restringir el acceso a las vistas previas - -
- -Las URLs de vista previa son públicamente accesibles por defecto. Para restringir el acceso a los miembros de su organización en Mintlify, habilite la autenticación de vista previa en la página [Add-ons](https://app.mintlify.com/products/addons) de su panel. - - - -Para invitar a un compañero de equipo a una página específica en una branch, copie la URL de la barra de direcciones de su navegador y compártala. Cualquier persona con acceso a su organización de Mintlify puede abrir el enlace directamente en su sesión del editor. - -El formato de la URL es: - -```text -https://app.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath} -``` - -Por ejemplo: `https://app.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx` - -
- -## Revisar y fusionar pull requests - -
- -Cuando hay una pull request abierta para la branch actual, el menú de publicación muestra un panel de revisión con: - -- El título y la descripción de la pull request, y si es un borrador. -- Las branches de origen y de destino. -- El número de archivos modificados. -- El requisito de aprobación en la deployment branch: **Approval required**, **Code owner required** o sin requisito. -- El estado actual de la revisión: **Approved**, **Changes requested** o **Awaiting review**. - -Haga clic en el enlace de la pull request para abrirla en GitHub, GitLab o Bitbucket. - -Después de que un revisor apruebe una pull request, haga clic en **Merge and publish** para fusionar y desplegar directamente desde el editor. El editor cambia a su deployment branch después de fusionar. - -
- -### Aprobar pull requests desde el editor - -
- -Para los repositorios de GitHub, los revisores pueden aprobar pull requests abiertas en el editor. Cuando hay una pull request abierta, aparece el botón **Approve pull request** en el panel de revisión si su cuenta tiene permiso para revisarla. Haga clic en **Approve pull request** cuando los cambios estén listos para fusionarse. El estado de la revisión cambia a **Approved** y la acción **Merge and publish** queda disponible. - -Si usa GitLab o Bitbucket, abra la pull request en su proveedor de Git para aprobarla. - - - Configure reglas de protección de branches en su proveedor de Git para exigir pull requests. Consulte [About protected branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) en la ayuda de GitHub o [Protected branches](https://docs.gitlab.com/user/project/repository/branches/protected/) en la ayuda de GitLab. - - -
- -### Revisar los cambios antes de fusionar - -
- -Haga clic en cualquier archivo modificado en el menú de publicación para abrirlo en la vista de diff y comparar su branch con la versión publicada. En modo visual verá un diff visual. En modo source verá un diff de texto. Los archivos que no pueden mostrar un diff, como imágenes o archivos eliminados, aparecen en la lista pero no se pueden abrir. - -El árbol de archivos resalta las páginas modificadas para que pueda ver de un vistazo qué archivos ha tocado una [automatización](/es/automations) o un compañero de equipo. Las páginas no listadas que aparecen en el diff de la branch también se pueden abrir desde el menú de publicación, aunque no aparezcan en la navegación de su sitio. - -
- -### Abrir una ejecución de automatización en el editor - -
- -Cuando una [automatización](/es/automations) abre una pull request, puede saltar directamente desde la interfaz de revisión de la ejecución o desde su notificación de Slack al editor en la branch de la automatización: - -- Desde la página **Automation Runs** en su panel, haga clic en **Open in editor** en una ejecución completada. -- Desde una notificación de Slack, haga clic en el enlace **View changes**. - -Cualquiera de los dos accesos abre el editor en la branch de la automatización con las páginas modificadas preseleccionadas en el menú de publicación. Puede revisar el diff y fusionar o solicitar cambios sin salir del editor. - -
- -### Publicaciones simultáneas - -
- -Solo puede haber una publicación a la vez por branch. Si otro miembro del equipo publica en la misma branch, espere a que termine la publicación actual antes de volver a intentarlo. - -
- -### Títulos y descripciones de pull requests - -
- -Si su organización requiere pull requests, puede introducir un título y una descripción al publicar. Si deja cualquiera de los dos en blanco, el editor usa un mensaje predeterminado que enumera los archivos que ha creado, actualizado, movido o eliminado. - -
- -## Resolver conflictos - -
- -Los conflictos ocurren cuando su branch y la deployment branch tienen cambios incompatibles en los mismos archivos. Por ejemplo, cuando usted y un compañero de equipo han editado las mismas líneas en un archivo o han movido un archivo a ubicaciones diferentes. - -El editor muestra una advertencia cuando los conflictos bloquean la publicación. Siga las indicaciones para elegir qué versión de cada sección en conflicto conservar. - -
- -## Colaborar en tiempo real - -
- -Cuando varias personas abren la misma página en la misma branch, editan juntas en tiempo real. El cursor y las ediciones de cada persona son visibles para todos, con avatares mostrados en la barra de herramientas. - -- Los cambios de todos los colaboradores se fusionan automáticamente. Dos personas editando la misma sección no generarán conflictos. -- Deshacer solo afecta a sus propias ediciones. -- Si pierde la conexión, las ediciones se guardan localmente y se sincronizan cuando se vuelve a conectar. - -Cuando el [agente de Mintlify](/es/agent) edita una página a través de la API o MCP, aparece en el editor como cualquier otro colaborador. Verá el avatar del agente en la barra de herramientas y un cursor en vivo en su edición más reciente. El cursor desaparece automáticamente después de que el agente termina. - -
- -## Sincronización con Git - -
- -Cuando alguien envía cambios a su repositorio desde fuera del editor, el editor incorpora esos cambios automáticamente. - -Los cambios que no se solapan se aplican automáticamente. Si un cambio remoto y su edición local afectan a la misma parte de una página, el editor resalta el conflicto para que pueda resolverlo. - -
- -## Firma de commits - -
- -Firme commits con su cuenta de GitHub autorizándola en la [configuración de su cuenta](https://app.mintlify.com/settings/account). Sin autorización, la app de GitHub de Mintlify firma los commits realizados en el editor web. - -Para una referencia de cómo las acciones del editor se corresponden con las operaciones de Git, consulte [Conceptos básicos de Git](/es/editor/git-essentials#how-the-editor-maps-to-git). diff --git a/es/editor/collaborate.mdx b/es/editor/collaborate.mdx new file mode 100644 index 0000000000..d2bea2e0b9 --- /dev/null +++ b/es/editor/collaborate.mdx @@ -0,0 +1,82 @@ +--- +title: "Colaborar en el editor" +sidebarTitle: "Colaborar" +description: "Deje comentarios, proponga cambios como sugerencias y edite junto a sus compañeros en tiempo real en el editor." +keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "real time"] +--- + +Trabaje con su equipo en una página comentándola, sugiriendo cambios o editándola conjuntamente al mismo tiempo. + +
+ +## Comentarios + +
+ +Los comentarios le permiten dejar opiniones sobre un texto concreto sin editar el contenido. + +**Los comentarios nunca llegan a su repositorio.** Existen solo dentro del editor y nunca se incluyen en el sitio publicado ni se confirman en Git. + +Para añadir un comentario, resalte un texto y haga clic en el icono **Comment** de la barra de herramientas. Para responder, haga clic en el texto resaltado o en el hilo de la barra lateral de comentarios. + + + El botón de comentario en la barra de herramientas flotante sobre el texto seleccionado en el editor. + El botón de comentario en la barra de herramientas flotante sobre el texto seleccionado en el editor. + + +Todos los [roles](/es/dashboard/roles) pueden comentar y responder, incluidos los viewers. Solo los editors y admins pueden resolver hilos. Resolver un hilo lo quita de la barra lateral y elimina el resaltado de la página. + +Puede eliminar sus propios comentarios y los admins pueden eliminar cualquier comentario. Eliminar el primer comentario de un hilo elimina el hilo completo. + +Escriba `@` para mencionar a un compañero. Debe ser miembro de su organización y recibirá una notificación por correo electrónico. + +Si su branch tiene una pull request abierta, Mintlify añade a su descripción un resumen de los hilos sin resolver, con un enlace a cada comentario. El resumen se actualiza a medida que cambian los hilos. + +
+ +## Sugerencias + +
+ +Las sugerencias proponen un cambio manteniendo el contenido actual, de modo que un compañero pueda aceptarlas o rechazarlas. + +Los editors y admins pueden aceptar o rechazar cualquier sugerencia. Los viewers no. + +Para hacer una sugerencia, resalte un texto y haga clic en el botón **Switch to Suggesting** de la barra de herramientas. En el modo de sugerencias, sus eliminaciones e inserciones aparecen como texto resaltado en lugar de como ediciones. Las sugerencias pendientes aparecen en la barra lateral junto a los comentarios. + + + Los [viewers](/es/dashboard/roles) están siempre en modo de sugerencias. El modo de sugerencias se activa automáticamente cuando un viewer abre el editor, de forma que pueda proponer cambios sin editar el contenido directamente. + + +Haga clic en una sugerencia resaltada para aceptarla o rechazarla. Cualquiera de las dos opciones resuelve y elimina el hilo de la sugerencia. Un cambio aceptado pasa a formar parte de su branch actual y se publica la próxima vez que [publique](/es/editor/publish). + +
+ +## Preguntar al agente de Mintlify + +
+ +Mencione `@mintlify` en un comentario, una sugerencia o una respuesta para preguntar al [agente del editor](/es/editor/agent) sobre la página actual. El agente se ejecuta en segundo plano con la página, el hilo y la branch como contexto, y luego publica su respuesta en el mismo hilo. + +```text +@mintlify does this endpoint support pagination? +@mintlify are there any pages that contradict this? +``` + +El agente funciona en modo de solo lectura cuando responde a comentarios. Puede buscar en su documentación, leer páginas, consultar contenido web y cargar skills, pero no puede editar contenido, crear sugerencias ni publicar. Para hacer cambios, abra directamente el [agente del editor](/es/editor/agent). + +Las menciones funcionan en páginas privadas para los miembros que ya tienen acceso. Cada respuesta cuenta para su uso del agente del editor. + +
+ +## Edición en tiempo real + +
+ +Cuando varias personas abren la misma página en la misma branch, editan conjuntamente. El cursor y las ediciones de cada persona son visibles para todos, con avatares en la barra de herramientas. + +- Los cambios de todos los colaboradores se combinan automáticamente. Que dos personas editen la misma sección no genera conflictos. +- Deshacer solo afecta a sus propias ediciones. +- Si pierde la conexión, sus ediciones se guardan localmente y se sincronizan cuando vuelve a conectarse. + +Cuando el [agente de Mintlify](/es/agent) edita una página a través de la API o de MCP, aparece como cualquier otro colaborador, con un avatar y un cursor en vivo en su edición más reciente. El cursor desaparece cuando el agente termina. diff --git a/es/editor/comments.mdx b/es/editor/comments.mdx deleted file mode 100644 index 6227c572b3..0000000000 --- a/es/editor/comments.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: "Comentarios" -description: "Deja comentarios en línea en las páginas del editor para dar retroalimentación, mencionar compañeros, hacer preguntas y discutir cambios con tu equipo." -keywords: ["editor", "comentarios", "colaboración", "retroalimentación", "menciones", "hilos"] ---- - -Los comentarios te permiten a ti y a tu equipo dejar retroalimentación sobre texto específico de una página sin editar el contenido. Usa los comentarios para hacer preguntas, señalar problemas o discutir cambios antes de publicarlos. - -Los comentarios solo existen dentro del editor. Nunca se incluyen en el sitio publicado ni se envían a tu repositorio. - -Todos los [roles](/es/dashboard/roles)—viewers, editors y admins—pueden dejar comentarios y responder a ellos. Solo los editors y admins pueden resolver hilos de comentarios. - -Si tu branch tiene una pull request abierta, Mintlify agrega un resumen de los hilos de comentarios sin resolver a la descripción de la pull request. El resumen enumera los archivos con comentarios abiertos, el primer comentario de cada hilo y un enlace para navegar hasta el comentario en el editor. - -El resumen se actualiza cuando agregas, resuelves o eliminas un comentario. - -
- ## Agregar un comentario -
- -1. Resalta el texto sobre el que quieres comentar. -2. Haz clic en el icono **Comment** en la barra de herramientas. -3. Escribe tu comentario y presiona Enter para enviarlo. - - - El botón de comentario en la barra de herramientas flotante sobre el texto seleccionado en el editor web. - El botón de comentario en la barra de herramientas flotante sobre el texto seleccionado en el editor web. - - -
- ## Responder a un comentario -
- -Para abrir un hilo de comentarios, haz clic en el texto resaltado o en el hilo en la barra lateral de comentarios. Escribe tu respuesta y presiona Enter para enviarla. - - - Un hilo de comentarios abierto en el editor web y dos hilos de comentarios en la barra lateral. - Un hilo de comentarios abierto en el editor web y dos hilos de comentarios en la barra lateral. - - -
- ## Mencionar a un compañero -
- -Escribe `@` en un comentario o respuesta para mencionar a un compañero. Las personas deben ser miembros de tu organización para que puedas mencionarlas. - -Los compañeros mencionados reciben una notificación por correo electrónico. - -
- ## Preguntar al agente de Mintlify -
- -Menciona `@mintlify` en un comentario, [sugerencia](/es/editor/suggestions) o respuesta para hacerle una pregunta al [agente del editor](/es/editor/agent) sobre la página actual. El agente se ejecuta de forma asíncrona con la página, el hilo y la branch como contexto, y luego publica su respuesta como una nueva respuesta en el mismo hilo. - -Usa las menciones `@mintlify` para hacer preguntas como: - -- `@mintlify does this endpoint support pagination?` -- `@mintlify is this the recommended way to configure webhooks?` -- `@mintlify are there any pages that contradict this?` - -El agente se ejecuta en modo de solo lectura cuando responde a comentarios. Puede buscar en tu documentación, leer páginas, obtener contenido web y cargar skills, pero no puede editar contenido, crear sugerencias ni publicar cambios. Para hacer cambios, abre el [agente del editor](/es/editor/agent) directamente. - -Las menciones `@mintlify` funcionan en páginas privadas para los miembros que ya tienen acceso. Cada respuesta del agente cuenta para tu uso del agente del editor. - -
- ## Resolver un comentario -
- -Los editors y admins pueden resolver los hilos cuando la discusión finaliza. - -Haz clic en el icono de marca de verificación para resolver un hilo. Los hilos resueltos se eliminan de la barra lateral de comentarios y se elimina el resaltado de la página. - - - Un hilo de comentarios abierto en el editor web con el icono de marca de verificación para resolver el hilo resaltado. - Un hilo de comentarios abierto en el editor web con el icono de marca de verificación para resolver el hilo resaltado. - - -
- ## Eliminar un comentario -
- -Haz clic en el icono de papelera junto a un comentario para eliminarlo. Eliminar el primer comentario de un hilo elimina todo el hilo. - -Puedes eliminar tus propios comentarios. Los admins pueden eliminar cualquier comentario. diff --git a/es/editor/configurations.mdx b/es/editor/configurations.mdx deleted file mode 100644 index 3d302ee135..0000000000 --- a/es/editor/configurations.mdx +++ /dev/null @@ -1,274 +0,0 @@ ---- -title: "Configuraciones" -description: "Edite la marca, apariencia, navegación y funciones desde el panel Configurations en el editor web de Mintlify, con sincronización en tiempo real." -keywords: ["editor", "configurations", "settings", "branding", "theme"] -boost: 3 ---- - -Configure la marca, la apariencia y las funciones de su sitio desde el panel **Site configurations** en el editor web. Los cambios de configuración se sincronizan en tiempo real con otros editores en la misma branch, de modo que su equipo siempre ve los ajustes más recientes. - -Para abrir el panel, haga clic en el icono de configuraciones en la barra de herramientas del editor. - - - Menú de Configurations en el editor. - Menú de Configurations en el editor. - - -El panel agrupa los ajustes en secciones que se corresponden con las propiedades de nivel superior de su [`docs.json`](/es/organize/settings). - -
- -## General - -
- -Establezca la identidad de su sitio y cómo aparece para los visitantes. - -- **Name**: El nombre de su proyecto. Aparece en las pestañas del navegador y en los resultados de búsqueda. -- **Description**: Breve descripción de su proyecto. Se utiliza para SEO y AEO. - -
- -## Marca - -
- -Suba las marcas que identifican su sitio. - -- **Logo**: El logo de su marca. Suba archivos PNG o JPG. Establezca versiones separadas para modo claro y oscuro y una URL opcional al hacer clic. Para usar un logo SVG, añada el archivo a su repositorio y referencie su ruta en su [`docs.json`](/es/organize/settings-appearance#logos). -- **Favicon**: Pequeño icono que aparece en las pestañas del navegador. Suba archivos ICO, PNG, GIF o JPG. Establezca versiones separadas para modo claro y oscuro si es necesario. - -
- -## Estilo - -
- -Controle la identidad visual y la paleta de colores de su sitio. - -- **Theme**: Elija un [tema](/es/customize/themes) para la apariencia general de su sitio. -- **Primary color**: El color de acento principal usado en todo su sitio para enlaces, botones y elementos destacados. -- **Light color**: Color de acento usado en modo oscuro. La forma en que los temas lo aplican varía según el tema. -- **Dark color**: Color de acento usado en modo claro. La forma en que los temas lo aplican varía según el tema. -- **Background color**: Colores de fondo personalizados para modo claro y oscuro. -- **Icon library**: Biblioteca de iconos usada para todas las propiedades de iconos. El valor predeterminado es `fontawesome`. -- **Strict appearance**: Bloquea el sitio en un único modo de apariencia y oculta el conmutador de tema. -- **Default appearance**: Indica si su sitio se carga en modo `system`, `light` o `dark` por defecto. -- **Background decoration**: Aplica un estilo visual (`gradient`, `grid` o `windows`) al fondo. -- **Background image**: Imagen de fondo opcional. Establezca una sola imagen o versiones separadas para modo claro y oscuro. - -
- -## Tipografía - -
- -Reemplace las fuentes predeterminadas con la tipografía de su marca. - -- **Font family**: Cualquier familia de [Google Fonts](https://fonts.google.com/) funciona sin configuración adicional. Para una fuente alojada por usted mismo, proporcione una URL de origen y un formato (`woff` o `woff2`). -- **Weight**: Normalmente `400` para regular y `700` para negrita. Las fuentes variables admiten pesos precisos como `550`. -- **Heading font**: Anulación opcional aplicada a todos los encabezados (`h1` a `h6`). -- **Body font**: Anulación opcional aplicada al cuerpo de texto y al resto de la página. - - - -Añada elementos de navegación a la parte superior de su sitio. - -- **Primary button**: La llamada a la acción principal en su cabecera. Establezca el tipo, la etiqueta y la URL de destino. -- **Navbar links**: Enlaces de navegación adicionales en su cabecera. Cada enlace incluye un texto y una URL. - - - -Añada enlaces y perfiles de redes sociales al pie de página de su sitio. - -- **Social links**: Perfiles en plataformas como GitHub, X, LinkedIn, Discord, YouTube y Slack. -- **Footer columns**: Habilítelo para organizar los enlaces del pie de página en hasta cuatro columnas con encabezados personalizados. - - - -Muestre una barra de anuncios en la parte superior de cada página. - -- **Content**: El texto del banner. Admite formato MDX básico como enlaces, negrita y cursiva. Los componentes personalizados no son compatibles. -- **dismissible**: Muestra un botón para descartar en el lado derecho del banner. -- **Type**: Estilo visual. `info` usa el color primario de la marca, `warning` usa un fondo ámbar y `critical` usa un fondo rojo. El valor predeterminado es `info`. -- **Color**: Anula el color de fondo del banner con un color hexadecimal personalizado. Establezca valores separados para modo claro y oscuro para colores adaptables al tema. - -
- -## Miniatura - -
- -Personalice las miniaturas de las páginas y las vistas previas para redes sociales. - -- **Background**: Imagen de fondo personalizada para las miniaturas. -- **Appearance**: Renderiza las miniaturas en modo `light` o `dark`. Cuando no se define, las miniaturas se generan automáticamente a partir de los colores de su tema. -- **Font**: Fuente personalizada para el texto en las miniaturas. - -
- -## Contenido - -
- -Personalice cómo aparece el contenido en su sitio. - -- **Page eyebrow**: Muestra etiquetas pequeñas que preceden a los títulos de las páginas. Elija `section` o `breadcrumbs`. -- **Timestamps**: Muestra la fecha de la última modificación del contenido en todas las páginas. -- **LaTeX**: Carga las hojas de estilo de LaTeX (KaTeX) para renderizar notación matemática. - -
- -## Bloques de código - -
- -Configure el resaltado de sintaxis y el comportamiento de los bloques de código. - -- **Code block theme**: Iguala el modo claro/oscuro del sitio con `system`, usa siempre un tema oscuro con `dark` o elija un tema personalizado de [Shiki](https://shiki.style/). -- **Custom code languages**: Registre lenguajes adicionales para el resaltado de sintaxis. - -
- -## Menú contextual - -
- -Configure las acciones rápidas que aparecen en el menú contextual de la página. - -- **Options**: Menú desplegable de selección múltiple con acciones como `copy`, `view` y abrir la página en `chatgpt`, `claude`, `cursor` y otros asistentes de IA. -- **Display**: Dónde mostrar las opciones. `header` (predeterminado) las muestra en el menú contextual en la parte superior de la página; `toc` las muestra en la barra lateral del índice de contenido. - - - -Ajuste el comportamiento de la navegación en todo su sitio. - -- **drilldown**: Navega automáticamente a la primera página cuando un usuario hace clic en un grupo de navegación. - - - -Personalice la experiencia de búsqueda y los comentarios. - -- **Search placeholder**: El texto que aparece en el cuadro de búsqueda antes de que los usuarios escriban. El valor predeterminado es `Search or ask`. -- **Feedback**: Muestra botones de pulgar arriba y pulgar abajo o un enlace "Suggest edits" en cada página. - -
- -## Referencia de API - -
- -Documente los endpoints de su API. - -- **OpenAPI specs**: Añada archivos de especificación OpenAPI para generar páginas de referencia de API. -- **AsyncAPI specs**: Añada archivos de especificación AsyncAPI para generar páginas de referencia de API. -- **MDX server**: Endpoints personalizados del servidor MDX para el playground de API. -- **Playground display**: Muestra el playground interactivo de la API, el playground simple de la API o ningún playground de API. -- **Proxy server**: Habilita o deshabilita el servidor proxy para las solicitudes de API. -- **`mdx.schema`**: Indica si se renderiza la sección de esquema en las páginas de referencia de API. - -
- -## Redirecciones - -
- -Use la sección **Redirects** para añadir, editar, buscar y eliminar redirecciones sin editar manualmente su archivo `docs.json`. Las redirecciones envían a los usuarios desde URLs antiguas a otras nuevas, lo cual es útil cuando renombra páginas o reestructura su sitio. Para más información, consulte [Redirecciones](/es/create/redirects). - -Cada redirección tiene los siguientes campos: - -- **Source**: La ruta desde la que redirigir, como `/old-path`. Admite comodines. -- **Destination**: La ruta a la que redirigir, como `/new-path`. Admite comodines. -- **Status**: El código de estado HTTP para la redirección. - - `308`: Redirección permanente. Úselo para contenido que se ha movido de forma permanente. Este es el estado predeterminado. - - `307`: Redirección temporal. Úselo cuando el movimiento es temporal. - - - Menú de redirecciones en el editor. - Menú de redirecciones en el editor. - - -Para añadir una redirección: - -1. Haga clic en **Add redirect**. -2. Introduzca el origen y el destino. -3. Haga clic en **Save**. - -Para editar o eliminar una redirección existente, pase el cursor sobre la fila y use el icono de edición en línea o la **X** para eliminarla. - -
- -## SEO - -
- -Configure las metaetiquetas y la indexación para los motores de búsqueda. - -- **metatags**: Etiquetas `` personalizadas aplicadas en todo su sitio. Añada pares clave-valor para etiquetas como `og:image` o `twitter:card`. -- **Indexing**: Elija si se deben indexar las páginas ocultas. - -
- -## Analítica - -
- -Conecte plataformas de analítica para rastrear el comportamiento de los visitantes. Los proveedores admitidos incluyen Amplitude, Mixpanel, Heap, Google Analytics, Google Tag Manager, PostHog, Plausible, Fathom, Segment, Hightouch, Hotjar, LogRocket, Microsoft Clarity, Intercom, Clearbit y más. - -Cada entrada se muestra como una fila en línea. Use el icono **X** para eliminar una integración. - -
- -## Página 404 - -
- -Personalice la experiencia cuando un usuario llega a una página inexistente. - -- **Redirect to home**: Cuando está activado, las páginas inexistentes redirigen a su página de inicio. Cuando está desactivado, el sitio muestra una página 404 y puede personalizar el título y la descripción a continuación. -- **Title**: Encabezado que se muestra en la página 404. -- **Description**: Subtítulo que se muestra en la página 404. - -
- -## Variables - -
- -Defina variables personalizadas que se pueden reutilizar en todo su contenido. Cada variable es un par clave-valor. Use el icono **X** para eliminar una variable. diff --git a/es/editor/git-essentials.mdx b/es/editor/git-essentials.mdx deleted file mode 100644 index 4f168d6e2e..0000000000 --- a/es/editor/git-essentials.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "Conceptos básicos de Git para el editor" -sidebarTitle: "Conceptos básicos de Git" -description: "Comprenda los conceptos de control de versiones de Git detrás del editor de Mintlify: branches, commits, pull requests y flujos de fusión." -keywords: ["git", "version control", "web editor", "branches", "commits", "pull requests", "PRs"] ---- - -Git le permite controlar y hacer seguimiento de los cambios en los archivos. Es el sistema de control de versiones detrás de los flujos de trabajo basados en branches, donde gestiona el contenido del mismo modo que cualquier otra base de código. - -El editor web se encarga de las operaciones de Git por usted. Comprender algunos conceptos clave le ayuda a aprovechar al máximo el editor y a colaborar eficazmente con su equipo. - -
- -## Lo que Git hace por su contenido - -
- -Git registra cada cambio realizado en su contenido. Anota qué cambió, quién lo cambió, cuándo lo cambió y por qué. Esto significa que puede: - -- Ver el historial completo de cualquier página. -- Deshacer cambios revirtiendo a una versión anterior. -- Trabajar en actualizaciones sin afectar a su sitio en producción. -- Revisar los cambios antes de que se publiquen. - -Su repositorio es la colección de archivos y su historial que conforman su sitio. El editor se conecta a este repositorio para sincronizar y publicar su contenido. - -
- -## Conceptos clave - -
- -Estos son los conceptos de Git con los que se encontrará con más frecuencia al usar el editor web. - - - - Una instantánea guardada de sus cambios en un momento específico. Cada commit incluye un mensaje que describe qué cambió y crea un registro permanente en el historial de su proyecto. - - Cuando publica cambios, el editor web crea un commit en su repositorio de Git. - - - Una línea de trabajo independiente en su repositorio. A veces se le llama **feature branch**. - - Su sitio en producción se compila desde una **deployment branch**, normalmente llamada `main`. Otras branches le permiten trabajar en cambios de forma independiente sin afectar a su sitio en producción. Nada en una branch se publica hasta que la fusiona con su deployment branch mediante una pull request. - - Cambie entre branches usando el menú desplegable de branches en la barra de herramientas del editor. Si tiene cambios sin publicar, el editor le permite llevarlos a la nueva branch o dejarlos en su branch actual. - - - La branch que compila su sitio en producción, normalmente llamada `main`. Los cambios fusionados en esta branch se despliegan automáticamente en su sitio. - - - Una propuesta para fusionar cambios de una branch en otra. Las pull requests permiten que su equipo revise y discuta los cambios antes de que se publiquen. - - Cuando publica cambios en una feature branch (o cuando su repositorio exige pull requests), el editor web crea una pull request. Su equipo revisa y fusiona la pull request en su proveedor de Git (GitHub, GitLab o Bitbucket). - - - Combinar cambios de una branch en otra. Después de que su equipo revisa y aprueba una pull request, fusionar la branch incorpora sus cambios en la deployment branch y los publica. - - - Ocurre cuando dos branches tienen cambios incompatibles en los mismos archivos. El editor le ayuda a resolver los conflictos cuando se producen. - - - Una comparación que muestra las diferencias entre dos versiones de un archivo. El editor muestra un diff visual de sus cambios pendientes antes de publicar para que pueda revisar exactamente lo que se va a confirmar. - - - -
- -## Cómo se relaciona el editor con Git - -
- -Cada acción en el editor web corresponde a una operación de Git. Aquí está la referencia completa: - -| Acción en el editor | Operación de Git | -|---|---| -| Editar una página | Los cambios se guardan automáticamente en los servidores de Mintlify. Aún no hay commit de Git. | -| Publicar en su deployment branch | `git commit` y `git push`. Desencadena un despliegue. | -| Save in branch | `git commit` en la feature branch actual. | -| Create pull request | `git push` y abre una pull request contra su deployment branch. | -| Merge and publish | Fusiona la pull request y desencadena un despliegue. | -| Crear una branch | `git checkout -b ` | -| Cambiar de branch | `git checkout ` | -| Push externo o actualización desde la CLI | Los cambios entrantes se sincronizan en el editor automáticamente mediante una fusión a tres bandas. | diff --git a/es/editor/index.mdx b/es/editor/index.mdx index 5f245a6b53..1742d4292a 100644 --- a/es/editor/index.mdx +++ b/es/editor/index.mdx @@ -1,21 +1,17 @@ --- title: "Descripción general del editor" sidebarTitle: "Descripción general" -description: "Cree, edite y publique contenido en el navegador con colaboración en tiempo real, guardado automático, vistas previas en vivo y sincronización con Git." -keywords: ["editor", "visual", "collaborative", "web editor"] +description: "Cree, edite y publique contenido en su navegador con el editor de Mintlify. Admite colaboración en tiempo real y sincronización continua con Git." +keywords: ["web editor", "git", "branches", "commits", "pull requests"] --- - - Un recorrido paso a paso: cree una branch, haga un cambio, comparta una vista previa y publique. + + Cree una branch, haga un cambio, comparta una vista previa y publique. -
+Use el editor para escribir y publicar documentación en su navegador. El editor usa un flujo de trabajo docs-as-code en el que Git respalda todos sus cambios. Su trabajo se guarda como commits en su repositorio y el editor gestiona las operaciones de Git por usted. -## Abrir el editor - -
- -Abre el editor desde la pestaña [Editor](https://app.mintlify.com/editor) en tu dashboard de Mintlify. Cualquier miembro de tu organización puede abrir el editor; lo que puedes hacer dentro depende de tu [rol](/es/dashboard/roles). Los admins y editors pueden editar y publicar, y los viewers pueden explorar el contenido y dejar [comentarios](/es/editor/comments) o [sugerencias](/es/editor/suggestions). +El editor se carga de forma predeterminada cuando abre su [dashboard](https://app.mintlify.com). Cualquier miembro de su organización puede abrirlo, pero ciertas acciones dependen de su [rol](/es/dashboard/roles). Los admins y editors pueden editar y publicar. Los viewers pueden explorar el contenido y dejar [comentarios y sugerencias](/es/editor/collaborate).
@@ -23,78 +19,84 @@ Abre el editor desde la pestaña [Editor](https://app.mintlify.com/editor) en tu
-**Los cambios se guardan automáticamente.** A medida que escribe, el editor guarda su trabajo. Sus cambios persisten entre pestañas, dispositivos e interrupciones de red. Los cambios solo se publican cuando usted los publica. +**Los cambios se guardan automáticamente, pero guardar es distinto de publicar.** A medida que escribe, el editor almacena su trabajo. Sus cambios persisten entre pestañas, dispositivos e interrupciones de red. Para que un cambio llegue a su sitio publicado, debe [publicarlo](/es/editor/publish). -**Git se mantiene sincronizado.** Cuando alguien envía cambios a su repositorio desde fuera del editor, esos cambios aparecen automáticamente en el editor. No necesita hacer pull ni actualizar. El editor fusiona los cambios que no entran en conflicto y resalta lo que requiere su atención. +**Publicar escribe en Git.** Cuando publica, el editor hace commit de sus cambios en su repositorio. Si publica en su deployment branch, su sitio publicado se actualiza de inmediato. En una feature branch, puede elegir si al publicar se actualiza el sitio publicado de inmediato o se abre una pull request para revisión. - - Si el editor alguna vez parece estar desincronizado con su repositorio, use [Reset editor](/es/editor/settings#reset-editor) para forzar una resincronización desde Git. Por ejemplo, el árbol de archivos está vacío o muestra `Unable to find docs.json` aunque el archivo esté presente en su deployment branch. - +**Git se mantiene sincronizado.** Cuando alguien hace push a su repositorio, esos cambios aparecen automáticamente. No necesita hacer pull ni actualizar la página. El editor combina los cambios que no entran en conflicto y señala todo lo que requiere su atención. -**Publicar escribe en Git.** Cuando publica, el editor confirma sus cambios en su repositorio. En una deployment branch, esto actualiza su sitio en producción de inmediato. En una feature branch, crea una pull request. +**Su equipo edita en conjunto.** Varias personas pueden editar la misma página a la vez, con cursores en vivo que muestran quién trabaja en cada parte. Los comentarios y las sugerencias son visibles para todos. -**Su equipo edita en conjunto.** Varias personas pueden editar la misma página al mismo tiempo. Los cursores en vivo muestran quién está editando y dónde. + + Si el editor alguna vez parece estar desincronizado con su repositorio, use [Restablecer editor](/es/editor/settings#reset-editor) para forzar una resincronización. Por ejemplo, aparece un árbol de archivos vacío o el error `Unable to find docs.json` cuando el archivo sí está presente en su deployment branch. + -
+
-## El diseño del editor +## Diseño del editor
- Captura de pantalla del editor que muestra el selector de branch, el botón ask agent, el botón publish, la barra lateral de navegación y la barra superior. - Captura de pantalla del editor que muestra el selector de branch, el botón ask agent, el botón publish, la barra lateral de navegación y la barra superior. + Captura de pantalla del editor con la pestaña Publishing seleccionada. + Captura de pantalla del editor con la pestaña Publishing seleccionada. -- **Barra superior**: Use la barra superior para controlar en qué branch trabaja, acceder al agente, ver una vista previa y publicar los cambios. -- **Barra lateral de navegación**: Seleccione una página para editar, cree nuevas páginas y administre la estructura del sitio. +* **Barra superior**: Use la barra superior para controlar en qué branch trabaja, acceder al agente, previsualizar y publicar cambios. +* **Barra lateral**: Use la barra lateral para seleccionar páginas que editar, crear páginas nuevas y gestionar la estructura de su sitio. + * **Home**: El árbol de archivos de su proyecto. Las páginas en **Personal** son privadas para usted. Las páginas en **Workspace** son públicas para su organización. + * **Publishing**: La estructura de navegación de su sitio. Organice las páginas como quiere que aparezcan en su sitio. -
+
-## Explorar el editor +## Modo visual y modo source
- - Cómo las branches y las reglas de protección determinan lo que sucede al publicar, y cómo gestionar el proceso de revisión de pull requests. - - - - Deja retroalimentación, haz preguntas y discute los cambios con tu equipo. - - - - Propón cambios que tus compañeros pueden revisar, aceptar o rechazar. - +**El modo visual** representa su página a medida que escribe. Presione / para abrir el menú de componentes e insertar componentes. - - Edite páginas, busque su contenido, modifique ajustes y configure su sitio desde una interfaz de chat. - +**El modo source** le da acceso directo al MDX. Úselo para tener control preciso sobre las propiedades de los componentes y el frontmatter. - - Añada páginas nuevas y actualice las existentes. - +Ambos modos editan el mismo archivo. Cambie entre ellos con Cmd + Shift + S (macOS) o Ctrl + Shift + S (Windows). - - Reordene las páginas y administre la estructura del sitio. - +Para conocer los componentes que puede insertar, consulte [Componentes](/es/components). Para la sintaxis de MDX, consulte [Dar formato al texto](/es/create/text) y [Dar formato al código](/es/create/code). - - Previsualice su sitio en tiempo real mientras edita, sin esperar a una compilación. - +
- - Configure la marca, los colores y las funciones de su sitio. - +## Conceptos de Git - - Configure las instrucciones de IA y los ajustes predeterminados de publicación para su deployment. - - - - Comprenda los conceptos de Git en los que se basa el editor: branches, commits, pull requests y merges. - +
- - Ahorre tiempo con atajos de teclado. - +Entender algunos conceptos de Git le ayuda a aprovechar mejor el editor. + + + + Una instantánea guardada de sus cambios en un momento concreto, con un mensaje que describe qué cambió. Publicar crea un commit. + + + Una línea de trabajo independiente. Su sitio publicado se compila desde una **deployment branch**, normalmente `main`. Otras branches, a veces llamadas **feature branches**, le permiten trabajar sin afectar su sitio publicado. Nada en una feature branch se publica hasta que hace merge. + + + Una propuesta para hacer merge de una branch en otra, de modo que su equipo pueda revisar los cambios antes de que se publiquen. Su equipo revisa y hace merge de las pull requests en GitHub, GitLab o Bitbucket, o [desde el editor](/es/editor/review). + + + Combinar los cambios de una branch en otra. Hacer merge en su deployment branch publica esos cambios. + + + Dos branches con cambios incompatibles en las mismas líneas. El editor le pide que elija qué versión conservar para resolver los conflictos antes de hacer merge. + + + Una comparación entre dos versiones de un archivo. El editor muestra un diff de sus cambios pendientes antes de que publique. + + + +| Acción en el editor | Operación de Git | +|---|---| +| Editar una página | Se guarda automáticamente. Todavía no hay commit. | +| Publicar en su deployment branch | `git commit` y `git push`. Activa un despliegue. | +| Save in branch | `git commit` en la feature branch actual. | +| Create pull request | `git push` y abre una pull request contra su deployment branch. | +| Merge and publish | Hace merge de la pull request y activa un despliegue. | +| Crear una branch | `git checkout -b ` | +| Cambiar de branch | `git checkout ` | +| Push externo o actualización por CLI | Los cambios entrantes se sincronizan en el editor mediante un merge de tres vías. | diff --git a/es/editor/keyboard-shortcuts.mdx b/es/editor/keyboard-shortcuts.mdx index 398c0b728e..21b1e65863 100644 --- a/es/editor/keyboard-shortcuts.mdx +++ b/es/editor/keyboard-shortcuts.mdx @@ -1,10 +1,10 @@ --- title: "Atajos de teclado" -description: "Consulte la lista completa de atajos de teclado para el editor web de Mintlify, incluyendo comandos de formato de texto, navegación y edición." +description: "Consulte la lista completa de atajos de teclado del editor web de Mintlify, incluidos los comandos de formato de texto, navegación y edición." keywords: ["editor", "keys", "keyboard", "shortcuts"] --- -Use atajos de teclado para navegar y editar más rápido en el editor web. El editor admite atajos comunes como copiar, pegar, deshacer y seleccionar todo, junto con los atajos que se enumeran a continuación. +Use los atajos de teclado para navegar y editar más rápido en el editor web. El editor admite atajos habituales como copiar, pegar, deshacer y seleccionar todo, además de los atajos que se enumeran a continuación.
@@ -12,16 +12,14 @@ Use atajos de teclado para navegar y editar más rápido en el editor web. El ed
-Estos atajos funcionan independientemente del modo en el que se encuentre. +Estos atajos funcionan sea cual sea el modo en el que esté. | Comando | macOS | Windows | | :--- | :--- | :--- | | **Buscar archivos y contenido** | Cmd + K | Ctrl + K | -| **Alternar el asistente de IA** (cuando no se edita texto) | Cmd + I | Ctrl + I | -| **Alternar entre modo visual y source** | Cmd + Shift + S | Ctrl + Shift + S | -| **Alternar la vista de diff** | Cmd + Shift + D | Ctrl + Shift + D | -| **Alternar entre Navigation y árbol de Files** | Cmd + Shift + F | Ctrl + Shift + F | -| **Ocultar/mostrar la barra lateral** | Cmd + \\ | Ctrl + \\ | +| **Mostrar u ocultar el asistente de IA** (cuando no está editando texto) | Cmd + I | Ctrl + I | +| **Cambiar entre el modo visual y el modo source** | Cmd + Shift + S | Ctrl + Shift + S | +| **Mostrar todos los archivos** (incluidos los dotfiles y los archivos que no son de contenido) | Cmd + Shift + . | Ctrl + Shift + . |
@@ -29,7 +27,7 @@ Estos atajos funcionan independientemente del modo en el que se encuentre.
-Use estos atajos al editar en modo visual. +Use estos atajos cuando edite en el modo visual.
@@ -49,17 +47,19 @@ Use estos atajos al editar en modo visual.
-### Encabezados +### Títulos
| Comando | macOS | Windows | | :--- | :--- | :--- | | **Texto** | Cmd + Option + 0 | Ctrl + Alt + 0 | -| **Encabezado 1** | Cmd + Option + 1 | Ctrl + Alt + 1 | -| **Encabezado 2** | Cmd + Option + 2 | Ctrl + Alt + 2 | -| **Encabezado 3** | Cmd + Option + 3 | Ctrl + Alt + 3 | -| **Encabezado 4** | Cmd + Option + 4 | Ctrl + Alt + 4 | +| **Título 1** | Cmd + Option + 1 | Ctrl + Alt + 1 | +| **Título 2** | Cmd + Option + 2 | Ctrl + Alt + 2 | +| **Título 3** | Cmd + Option + 3 | Ctrl + Alt + 3 | +| **Título 4** | Cmd + Option + 4 | Ctrl + Alt + 4 | +| **Título 5** | Cmd + Option + 5 | Ctrl + Alt + 5 | +| **Título 6** | Cmd + Option + 6 | Ctrl + Alt + 6 |
@@ -69,7 +69,7 @@ Use estos atajos al editar en modo visual. | Comando | macOS | Windows | | :--- | :--- | :--- | -| **Lista con viñetas** | Cmd + Shift + 8 | Ctrl + Shift + 8 | +| **Lista sin ordenar** | Cmd + Shift + 8 | Ctrl + Shift + 8 | | **Cita en bloque** | Cmd + Shift + B | Ctrl + Shift + B |
@@ -80,10 +80,10 @@ Use estos atajos al editar en modo visual. | Comando | macOS | Windows | | :--- | :--- | :--- | -| **Añadir enlace** al texto seleccionado | Cmd + K | Ctrl + K | -| **Insertar salto de línea** | Cmd + Enter | Ctrl + Enter | +| **Añadir un enlace** al texto seleccionado | Cmd + K | Ctrl + K | +| **Añadir un salto de línea** | Cmd + Enter | Ctrl + Enter | | **Comentar el texto resaltado** | Cmd + Shift + M | Ctrl + Shift + M | -| **Alternar el modo de sugerencias** | Cmd + Shift + E | Ctrl + Shift + E | +| **Activar o desactivar el modo de sugerencias** | Cmd + Shift + E | Ctrl + Shift + E | | **Menú de componentes** | / | / | | **Selector de emojis** | : + palabra clave | : + palabra clave | @@ -93,9 +93,9 @@ Use estos atajos al editar en modo visual.
-El editor convierte automáticamente ciertas secuencias de caracteres en símbolos tipográficos a medida que escribe. El editor omite las sustituciones dentro de bloques de código y código en línea. +El editor convierte automáticamente ciertas secuencias de caracteres en símbolos tipográficos mientras escribe. El editor omite las sustituciones dentro de los bloques de código y del código en línea. -| Tipo | Resultado | +| Escriba | Resultado | | :--- | :--- | | `->` | → | | `<-` | ← | @@ -110,7 +110,7 @@ El editor convierte automáticamente ciertas secuencias de caracteres en símbol
-El modo source usa el editor Monaco, que admite los atajos de teclado estándar de VS Code. +El modo source usa CodeMirror. Funcionan la mayoría de los atajos habituales de los editores de código, además de los que aparecen a continuación.
@@ -121,7 +121,7 @@ El modo source usa el editor Monaco, que admite los atajos de teclado estándar | Comando | macOS | Windows | | :--- | :--- | :--- | | **Buscar archivos** | Cmd + K | Ctrl + K | -| **Buscar** | Cmd + F | Ctrl + F | +| **Buscar en la página** | Cmd + F | Ctrl + F |
@@ -131,12 +131,16 @@ El modo source usa el editor Monaco, que admite los atajos de teclado estándar | Comando | macOS | Windows | | :--- | :--- | :--- | -| **Comentar/descomentar** | Cmd + / | Ctrl + / | -| **Indentar línea** | Tab | Tab | -| **Quitar sangría de la línea** | Shift + Tab | Shift + Tab | -| **Mover línea hacia arriba** | Option + ↑ | Alt + ↑ | -| **Mover línea hacia abajo** | Option + ↓ | Alt + ↓ | -| **Duplicar línea** | Shift + Option + ↓ | Shift + Alt + ↓ | +| **Negrita** (envuelve en `**`) | Cmd + B | Ctrl + B | +| **Cursiva** (envuelve en `_`) | Cmd + I | Ctrl + I | +| **Comentar o descomentar** | Cmd + / | Ctrl + / | +| **Plegar todo** | Cmd + Option + Shift + [ | Ctrl + Alt + Shift + [ | +| **Desplegar todo** | Cmd + Option + Shift + ] | Ctrl + Alt + Shift + ] | +| **Aumentar la sangría de la línea** | Tab | Tab | +| **Reducir la sangría de la línea** | Shift + Tab | Shift + Tab | +| **Subir la línea** | Option + ↑ | Alt + ↑ | +| **Bajar la línea** | Option + ↓ | Alt + ↓ | +| **Duplicar la línea** | Shift + Option + ↓ | Shift + Alt + ↓ |
@@ -144,8 +148,12 @@ El modo source usa el editor Monaco, que admite los atajos de teclado estándar
+{/* vale Mintlify.WordList = NO */} + | Comando | macOS | Windows | | :--- | :--- | :--- | -| **Añadir cursor** | Option + clic | Alt + clic | -| **Añadir cursor encima** | Cmd + Option + ↑ | Ctrl + Alt + ↑ | -| **Añadir cursor debajo** | Cmd + Option + ↓ | Ctrl + Alt + ↓ | +| **Añadir un cursor** | Option + clic | Alt + clic | +| **Añadir un cursor arriba** | Cmd + Option + ↑ | Ctrl + Alt + ↑ | +| **Añadir un cursor abajo** | Cmd + Option + ↓ | Ctrl + Alt + ↓ | + +{/* vale Mintlify.WordList = YES */} diff --git a/es/editor/live-preview.mdx b/es/editor/live-preview.mdx deleted file mode 100644 index 8c52e6493e..0000000000 --- a/es/editor/live-preview.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "Vista previa en vivo" -description: "Previsualice su sitio en tiempo real mientras edita, con actualizaciones continuas que renderizan al instante los cambios de contenido y configuración." -keywords: ["editor", "preview", "live preview"] ---- - -Previsualice su sitio mientras edita. Las vistas previas en vivo renderizan las páginas exactamente como se ven cuando se publican. Se actualizan a medida que realiza cambios en el contenido, la navegación y la configuración. - -
- -## Abrir la vista previa en vivo - -
- -Haga clic en el botón de vista previa en vivo en la barra superior. - - - El botón de vista previa en vivo en la barra de herramientas. - El botón de vista previa en vivo en la barra de herramientas. - - -
- -## Editar la configuración del sitio en la vista previa en vivo - -
- -Edite la configuración del sitio en la vista previa en vivo para ver cómo afecta al contenido renderizado. - -1. Abra la vista previa en vivo dentro del editor. -2. Haga clic en **Site settings** en la barra de herramientas de la vista previa. -3. Seleccione una sección de configuración y edite sus opciones. - -Si configura la vista previa en vivo para que se abra en una nueva pestaña, el menú de configuración del sitio no estará disponible. Desactive **Open live preview in new tab** en la [configuración del editor](/es/editor/settings) para usar el menú de configuración del sitio. - -
- -## Preguntar al agente en la vista previa en vivo - -
- -Haga clic en **Ask agent** en la barra de herramientas de la vista previa para abrir el [agente del editor](/es/editor/agent) junto a la vista previa en vivo. Solo los editores y administradores pueden usar el agente en las vistas previas en vivo. - - - La vista previa en vivo funciona en sitios públicos y en sitios protegidos con autenticación de Mintlify. En sitios autenticados, el editor inicia sesión automáticamente en la vista previa. - - -
- -## Vista previa en vivo frente a despliegues de vista previa - -
- -| | Vista previa en vivo | Despliegue de vista previa | -|---|---|---| -| **Velocidad** | Al instante | Requiere una compilación | -| **Acceso** | URL local, con autenticación automática para sitios protegidos | URL para compartir | -| **Cuándo usarla** | Para revisar cambios mientras edita | Para compartir con su equipo para su revisión | -| **Disponibilidad** | Mientras el editor esté abierto | Mientras exista la branch | - -Use la vista previa en vivo para obtener retroalimentación inmediata mientras edita. Cuando necesite compartir cambios con su equipo, use un [despliegue de vista previa](/es/editor/branching-and-publishing#preview-your-changes). También puede usarlo para probar los cambios en un dispositivo diferente. diff --git a/es/editor/media.mdx b/es/editor/media.mdx deleted file mode 100644 index 090a82afdd..0000000000 --- a/es/editor/media.mdx +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: "Agregar contenido multimedia" -description: "Sube, gestiona e inserta imágenes y otros recursos multimedia en tus páginas de documentación usando el gestor de archivos integrado del editor web de Mintlify." -keywords: ["editor","media","images","assets"] ---- - -
- ## Tipos de archivo admitidos -
- -* **Imágenes**: PNG, JPG, JPEG, GIF, WebP (máx. 20 MB) -* **Vídeos**: MP4, WebM (máx. 20 MB) -* **Fuentes**: TrueType (TTF), WOFF, WOFF2 -* **Otros**: PDF, ICO (favicons) - -
- ## Agregar contenido multimedia a una página -
- -
- ### Arrastrar y soltar -
- -Arrastra y suelta contenido multimedia desde tu computadora o desde el gestor de recursos sobre una página. En modo visual, la imagen o el video se insertan en línea. En Modo Markdown, el editor inserta la ruta en la posición de tu cursor. Las imágenes se guardan en la raíz de tu carpeta `images/`, y los videos se guardan en la raíz de tu carpeta `videos/`. - -
- ### Comando slash -
- -Escribe /image para abrir el menú de imágenes o /video para abrir el menú de vídeos. Sube contenido multimedia nuevo o selecciona entre los archivos existentes. - -
- ### Incrustar -
- -Escribe /embed y pega una URL de YouTube, Loom o Vimeo. El editor detecta el proveedor y genera el iframe automáticamente. Al buscar en el menú slash, los términos `youtube`, `yt`, `loom` y `vimeo` también muestran el comando **Embed**. - -Para otras incrustaciones, escribe /embed y activa **Inserción manual** para escribir HTML personalizado. - -
- ### Subir archivos -
- -Usa el explorador de archivos en la barra lateral para subir o buscar archivos. Arrastra y suelta archivos en una carpeta para organizar recursos multimedia. - - - Explorador de archivos abierto en el menú de la barra lateral del editor. - - Explorador de archivos abierto en el menú de la barra lateral del editor. - - -
- ## Formatear imágenes -
- -Después de insertar una imagen en el modo visual, pasa el cursor por encima para mostrar una barra de herramientas con opciones de formato. - -- **Vista previa en modo claro/oscuro**: Cambia entre el modo claro y oscuro para ver cómo se ve la imagen en cada tema. -- **Alineación**: Establece la alineación de la imagen como izquierda, centrada, derecha o a todo el ancho. -- **Frame**: Envuelve la imagen en un componente `` para añadir un borde y un fondo. -- **Configuración**: Reemplaza la imagen o actualiza su texto alternativo. - -
- ## Administra los recursos -
- -
- ### Organiza con carpetas -
- -Haz clic en el botón **+** del explorador de archivos para crear una nueva carpeta. Arrastra y suelta archivos y carpetas en el árbol de archivos para reordenarlos. - -
- ### Renombrar y editar recursos -
- -Pasa el cursor sobre un recurso y haz clic en el botón **...** para cambiar el nombre del archivo o actualizar su texto alternativo (alt). - -
- ### Eliminar recursos -
- -Pasa el cursor sobre un recurso y haz clic en el botón para eliminarlo. - -
- ## Mejores prácticas -
- -- **Usa nombres descriptivos**: Pon nombres claros a los archivos, como `api-dashboard-light.png` en lugar de `img1.png`. -- **Agrega texto alternativo (alt text)**: Proporciona texto alternativo descriptivo para mejorar la accesibilidad y el SEO. -- **Organiza con carpetas**: Agrupa los recursos relacionados, como variantes de modo claro y oscuro o recursos para un área de funcionalidad específica. -- **Usa formatos apropiados**: PNG para gráficos con transparencia, JPG para fotos, SVG para iconos y logotipos (no puedes subir archivos SVG a través del editor, pero puedes agregarlos a tu repositorio mediante Git). \ No newline at end of file diff --git a/es/editor/navigation.mdx b/es/editor/navigation.mdx deleted file mode 100644 index b98f313b75..0000000000 --- a/es/editor/navigation.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Organizar la navegación" -description: "Reordena páginas, agrega grupos y gestiona la barra lateral de tu documentación con arrastrar y soltar en el editor web de Mintlify, sin tocar docs.json." -keywords: ["editor", "navigation", "sidebar", "structure"] ---- - -Usa la barra lateral de navegación para organizar tu documentación. Los cambios que realices en el editor se sincronizan con tu repositorio cuando publicas: no necesitas editar `docs.json` manualmente. - -
- ## Agregar elementos de navegación -
- -Haz clic en **Add new** en la parte inferior del árbol de navegación para añadir un nuevo elemento en el nivel raíz. Para añadir un elemento anidado dentro de otro, haz clic en el botón de signo más que aparece junto a ese elemento. - -Arrastra y suelta los elementos para reordenarlos o anidarlos. Pasa el cursor sobre un elemento y haz clic en el icono de engranaje para configurar sus propiedades. - -Haz clic con el botón derecho en una **página** para abrir su configuración o eliminarla. - -Haz clic con el botón derecho en un **elemento de navegación** para abrir su configuración, convertirlo en otro tipo de elemento, duplicarlo, añadir una página o un grupo en su interior, desagruparlo o eliminarlo. - - - Algunos elementos no pueden anidarse dentro de otros. Por ejemplo, las pestañas no pueden anidarse dentro de grupos. El editor te impide crear combinaciones no válidas. - - - - -Elige la estructura adecuada para tu contenido: - -- **Pages**—Archivos individuales de documentación. El bloque de construcción principal de la navegación. -- **Groups**—Secciones plegables que agrupan páginas relacionadas. Pueden anidarse dentro de otros grupos. -- **Tabs**—Secciones de nivel superior con navegación horizontal en la parte superior del sitio. Úsalas cuando tengas áreas distintas como API Reference y Guides. -- **Anchors**—Elementos persistentes en la parte superior de la barra lateral. Útiles para acceder rápidamente a recursos externos o secciones de nivel superior. Pueden ser globales para aparecer en todas las páginas. -- **Dropdowns**—Menús desplegables en la parte superior de la barra lateral. Una alternativa más ligera a las pestañas para varias secciones relacionadas. -- **Menus**—Elementos de navegación desplegables dentro de una pestaña para enlazar directamente con páginas específicas. -- **Products**—Un selector para varios conjuntos de documentación de productos distintos, cada uno con su propia estructura de navegación. -- **Versions**—Un selector para varias versiones simultáneas de la documentación. -- **Languages**—Un selector para documentación en varios idiomas. - -
- ## Configurar elementos -
- -Pasa el cursor sobre cualquier elemento de navegación y haz clic en el icono de engranaje para definir: - -- **Title**: La etiqueta que se muestra en la barra lateral. -- **Icon**: Un marcador visual junto a la etiqueta. -- **Tag**: Una insignia como "NEW" o "BETA" para destacar el elemento. diff --git a/es/editor/pages.mdx b/es/editor/pages.mdx index 1887f52d8a..c5e0c9be91 100644 --- a/es/editor/pages.mdx +++ b/es/editor/pages.mdx @@ -1,246 +1,94 @@ --- title: "Crear y editar páginas" -description: "Cree páginas, edite contenido, suba imágenes y vídeos y administre archivos en el editor web de Mintlify con edición enriquecida y búsqueda global." -keywords: ["editor", "content", "pages", "files", "create", "edit", "version history", "media", "images", "video", "task lists", "private pages"] +sidebarTitle: "Editar contenido" +description: "Cree páginas, edite contenido, añada archivos multimedia, organice su navegación y recupere versiones anteriores de una página en el editor." +keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages"] --- -