Postman editor - onboarding guide

Number of APIs: 0

We are excited to introduce the new Qodex editor with WYSIWYG (What You See Is What You Get) editing experience to documentation, which will make documenting your collections and APIs faster, effortless, and, we think, much more fun.

Reliance on markdown

Writing descriptions in markdown for eventual human consumption of your documentation can be an exercise in itself and can get cumbersome, especially when your descriptions are large or when you present information in the form of tables, code, images, etc. Not being aware of markdown functionality limits the ability to create beautiful documentation.

With the new Qodex editor, we want to remove this reliance on Markdown to document your collections and APIs.

WYSIWYG description editor

Qodex’s new WYSIWYG description editor simplifies authoring descriptions in your documentation considerably - no need to use markdown or preview your changes.

The WYSIWYG editor is designed to fit everyone’s needs.

• If you are proficient with markdown already, you can use markdown triggers
• If you are used to non-markdown editors, you can use common shortcuts available across standard editors:
• All the formatting options are accessible through a toolbar as well.

Formatting text

Presenting information

Code Blocks

Code blocks can be triggered with three `s or using the tool bar.

{
  ## this is a code block
}

Images

Images can be inserted using the tool bar and a URL to the image.

Tables

Tables can be created using ⌥ + ⇧ + T or through the tool bar

Blockquotes

Blockquotes can be triggered by using > followed by space or through the tool bar.

Ordered and unordered lists

Ordered and unordered lists can triggered using - followed by space or followed by .

• This is an
  • unordered list

1. This is an
   1. ordered list

Line separators

Line separators can be inserted using --- followed by space.

---

Limitations

Since this is only the initial version of the editor, the following limitations apply

1. Since descriptions will be saved as markdown in collections, the editor functionality is bound to markdown functionality in general.
2. Nested blocks like lists inside tables, images inside tables, tables inside lists, etc. are not supported as of now.
3. If your existing collections descriptions have html tags. We suggest using the classic markdown editor until we fully support adding html elements to the new editor.

Feedback

What do you think about the new editor? You can also give product feedback through our [Community forum] and GitHub repository.