Customer StoriesReadMe Blog
Start typing to search…

Welcome to Our New Editing UI

We're excited to introduce you to our new editing experience! This version significantly improves how you create, edit, and publish documentation. Let's explore the key benefits and features of this new UI.

Key Benefits

  1. Streamlined Documenting: All documentation tasks now happen directly on your docs site.
  2. WYSIWYG Experience: See exactly how changes will look for your customers before they go live.
  3. Unified Experience: The same UI for both admins and API users, allowing for easy edits on the fly.
  4. MDX Support: Leverage Markdown and JSX to create rich, interactive docs (coming soon).
  5. Improved Search: Higher-quality, more accurate search results for your developers.

New & Updated Features

✏️ Edit Mode

  • Toggle between Edit and View modes directly on your live site.
  • Access the full MDX-powered editor, sidebar, and page navigation functionalities in Edit mode.
  • Create and edit Guides pages, Recipes, Changelog posts, and Custom Pages seamlessly.

♻️ Content Settings

  • Manage Reusable Content and Glossary directly in the editing UI.
  • Add or edit glossary terms easily. Use << to search and insert glossary terms in your docs.
  • Access Content Settings from the top right navigation, indicated by a content icon.

🎨 Appearance Settings

  • Preview visual changes like brand, logo, and site navigation updates in real-time.
  • Access Appearance Settings from the top navigation, indicated by a paintbrush icon.

➕ Versions

  • Manage versions through the dropdown in the editing UI menu.
  • End users can still toggle between active versions on the hub.

⚙️ Project Menu

  • Navigate effortlessly between editing docs and managing project/account settings.

Using the Editor

Accessing the New UI

When logging in to your ReadMe account, your project will be automatically opened in the new editing UI.

Navigating the Interface

  1. Use the left sidebar to access different sections of your documentation.
  2. You can add new categories using the + NEW CATEGORY button.
  3. The top menu bar contains options for Edit/View mode, Versions, Content Settings, Appearance Settings, and the Project Menu.

Creating/Editing Content

  • Click Edit to toggle edit mode using at the top of the page.
  • To create or modify your content use Markdown and JSX.
  • Use the slash commands (type /) to add new elements like images, code blocks, and other content types.
  • Remember to save your changes after making edits.

Managing Appearance

  • Click the paintbrush icon in the top navigation to access Appearance Settings.
  • Here you can make changes to your site theme, navigation, layout, and more and see your updates on the live site.

Using Content Settings

  • Click the content icon in the top right navigation to access Content Settings.
  • Add or edit Reusable Content and Glossary terms.
  • See updates reflected across your documentation.

Publishing Changes

  • After making edits, save your changes.
  • Toggle to View mode to see how your changes look on the live site.
  • Your saved changes are automatically published to your live docs.

Managing Versions

  • Use the Versions dropdown in the top menu to switch between or manage different versions of your docs.

Important Note

Once you upgrade to this new editing UI, you won't be able to revert to the previous editing experience. We're confident that these upgrades will significantly improve your workflow and your developers' experience with your docs.

We're excited for you to explore our new editing experience! If you have any questions or feedback, please don't hesitate to reach out to our support team at [email protected].