How to use the Editor
1 min
First of all, welcome! 👋
The Editor is like your second home and you need to know where everything is at all times.
That's why it's important that we highlight a few main concepts to set you on your merry way:
- Enter in edit mode by pressing on &#xNAN; Edit button or use the Ctrl / Cmd + E shortcut. You can use the same shortcut or to press on &#xNAN; Preview button to lock your document and to see how it looks before publishing it.
- If you have Review System enabled, check here for more details.
- Use forward slash / to add a new content block (see all blocks herehere). There are four categories:
- Basic - with multiple blocks that help you format documents
- Media - use these to import files, images, embed Youtube or Vimeo videos
- Developer - you will use these when you write software documentation because you will leverage:
- Code editor: multi-languageCode editor: multi-language
- Mermaid diagramsMermaid diagrams
- API endpointsAPI endpoints
- OpenAPI/Swagger blockOpenAPI/Swagger block
- GraphQLGraphQL
- Embed - most of our integrations work inside the editor. You can add embeds from other tools like Loom, Figma, Miro, Lucidcharts, and more. Check the Embed Examples page for more info.
- Write using Markdown shortcutsMarkdown shortcuts and check the keyboard shortcuts by pressing Ctrl or Cmd + /
- Use WYSIWYG MenuWYSIWYG Menu for formatting options on each piece of text when you highlight or double-click.
- Start Using @ Mentions and dynamic linksUsing @ Mentions and dynamic links after you add more documents to link between them.
Copy-pasting text maintains the formatting, and what's super neat about it is that you can add images this way (instead of importing them).
Also, when you paste markdown, the editor automatically recognizes it and renders the format correctly.