The content editor

The content editor is the main tool used for editing documents. It's where you'll be writing your content, adding links, images, etc…

Writing content

You can write content in the editor as if you would on any other text editor. The editor supports some markdown syntax, for example, typing ## when starting a new line will transform it into an H2 heading.

Any text you write inside the content editor can be modified and stylised using the editor menus.

There are two main menus used while editing content. The selection menu and the slash command menu.

The selection menu appears whenever you select content within the editor. It helps you turn the current selected word or node into other elements. You can easily add bold, italics, links, etc…

The slash command menu appears whenever you type /. It allows you to create headings, add images, code blocks, quotes, etc... You can either use the arrow keys to navigate the commands or start typing to filter them.

Uploading images

You can enhance your documents by incorporating images using various methods: choose the 'Image' command from the slash command menu, then select if you want to upload or link to the image. You can also paste your desired picture, or simply drag and drop it into the document.

Images are uploaded to your /public/docs/images folder. Outstatic fetches the images directly from GitHub so they can be visualised instantly on the editor, even if your website hasn't finished deploying.

AI Completion

Outstatic provides immediate access to AI completion functionality, seamlessly integrated and ready to use. This feature is driven by the leveraging OpenAI's API. To harness its capabilities, follow these simple steps:

  1. Obtain an OpenAI API key (get one here).
  2. Integrate this key into your system by setting it as an environment variable using the following template:
OPENAI_API_KEY=sk-XXXXXXXXXXXXXXXXXXXXXXXXX

When this is done you will be able to trigger completion in two ways. Through the slash command menu by selecting the Continue writing option, or by typing ++.

Outstatic's AI-powered completions offers you an effortless writing experience by suggesting content continuations and creative directions in real-time.

GitHub