Editing Markdown Files

OpenCloud uses a Tiptap-based Markdown editor for files such as README.md and other .md files. The editor helps you write and format content even if you do not know Markdown syntax well.

How the Editor Works

When you open a Markdown file, OpenCloud shows it in the editor so you can write and update the file directly in the browser.

You can add headings, lists, links, quotes, code, and other common formatting without leaving the file view.

As you edit, OpenCloud shows the Markdown content rendered right away so you can immediately see how the file will look.

The editor also supports inserting images and creating tables, which makes it easier to build richer Markdown files directly in OpenCloud.

Use the Slash Shortcut

Type / in a new line to open the formatting menu.

The menu gives you a quick overview of the available formatting options and lets you insert them without memorizing every shortcut.

This is especially helpful when you want to insert formatting quickly while keeping your hands on the keyboard.

Use the Formatting Toolbar

Use the formatting toolbar above the editor to insert common Markdown elements.

Click the Heading button to choose a heading level or use the other buttons for bold, italic, lists, code, images, and tables.

This is especially helpful if you want to format content quickly without memorizing every Markdown shortcut.

Supported Formatting

The Markdown editor supports common formatting options for all Markdown files. You can use the toolbar or the slash menu to insert:

• headings
• bold and italic text
• bullet and numbered lists
• quotes
• inline code and code blocks
• links
• images
• tables

Good To Know

• The editor works for Markdown files such as README.md.
• You can use the formatting menu to build structured content step by step.
• The file stays a normal Markdown file, so it can still be used outside OpenCloud.

When the file is saved, the Markdown content is stored in the same .md file and can be rendered wherever Markdown is supported.