Made in DeveloperHub
Writing documentation on DeveloperHub cannot be any easier. In your editor pages, click anywhere on the text in your documentation and start writing down. You can even use the AI Writer to help you craft the best content. Everything in the editor will be shown to you just as your readers, so there is no split view and no separate preview to keep in sync.
Editing
The editor works in place: what you see is what your readers get. Three things are worth knowing to get around quickly.
Add a block. Type / on an empty line to open the insert menu, then search for and pick the block you want (a callout, image, table, code block and more). See blocks for the full list.
Format text. Select any text to bring up the formatting toolbar. From there you can make text bold, italic, underlined, struck through or
inline code, turn the block into a heading or list with Turn into, add a link, or leave a comment.Move or change a block. Hover over a block and use the drag handle to its left to move it, or open the handle's menu for more options such as deleting the block.
You can also drop in links, variables and glossary terms inline by typing @, % or <.
Page Sections
Pages must have a title and content.
Title
The title of the page will be visible in:
The index of the documentation.
The title of the browser tab.
The URL of the page.
So choose the title carefully to be meaningful to your readers.
Content
The content of the page can consist of text, tables, images, links, code blocks, lists, information boxes, and much more! Have a look at blocks to find all the content that we natively support.
Saving
To save a page, hit the Save Draft button at the bottom right. Your edits will be saved in draft mode until you publish them. Every edit you make is saved in the page history.
When you are ready to publish the changes to your readers, click the Publish button .
Spell Check
Your browser spell checker is doing its job right away.