diff --git a/docs.json b/docs.json index e364b4726..aea417818 100644 --- a/docs.json +++ b/docs.json @@ -22,6 +22,7 @@ "index", "quickstart", "installation", + "editor", { "group": "Web editor", "icon": "mouse-pointer-2", @@ -534,10 +535,7 @@ "source": "api-reference/chat/*", "destination": "api-reference/assistant/*" }, - { - "source": "editor", - "destination": "editor/getting-started" - }, + { "source": "guides/analytics", "destination": "analytics/overview" diff --git a/editor.mdx b/editor.mdx new file mode 100644 index 000000000..0562adec5 --- /dev/null +++ b/editor.mdx @@ -0,0 +1,79 @@ +--- +title: "Web editor" +description: "Make quick updates and manage content with our browser-based editor" +--- + +Mintlify web editor interface in light mode + +Mintlify web editor interface in dark mode + +The Mintlify web editor is a powerful, browser-based interface that lets you create, edit, and manage your documentation without any local setup. Whether you're making quick updates or authoring comprehensive guides, the web editor provides everything you need to maintain professional documentation. + +## Key features + +- **Visual editing**: WYSIWYG editor that shows exactly how your content will appear when published +- **Git integration**: Automatic synchronization with your repository for seamless version control +- **Real-time collaboration**: Multiple team members can work simultaneously on documentation +- **Component library**: Add callouts, code blocks, and interactive elements with slash commands +- **Dual editing modes**: Switch between visual and Markdown modes based on your preference +- **Branch management**: Create and manage branches directly from the editor interface + +## Getting started + +Ready to start editing your documentation? The web editor makes it easy to jump in and begin creating content immediately. + + + Learn the basics of using the web editor, from opening files to publishing changes + + +## Editor workflow + + + + Navigate to your Mintlify dashboard and open the web editor from your project + + + Select an existing branch or create a new one for your changes + + + Use visual mode for WYSIWYG editing or Markdown mode for direct code access + + + Review your changes in real-time and publish when ready + + + +## Learn more + +Explore the complete web editor documentation to master all its features: + + + + Understand how the editor works with Git for version control + + + Learn best practices for collaborating with branches + + + Discover advanced techniques for organizing and structuring content + + + Understand different ways to publish your documentation changes + + + +## Need help? + +If you encounter any issues or have questions about the web editor, check out our troubleshooting guide or reach out to our support team. + + + Common issues and solutions for the web editor + \ No newline at end of file