Appearance
Using Auralis Studio
Write and maintain your documentation without editing files by hand. Studio works with the same Markdown pages that power the Auralis website.
Your writing workflow
- Choose a collection and a page in the library.
- Write in Visual mode. Use the toolbar for headings, lists, links, images, tables, and code.
- Adjust the page title, summary, and navigation label in Page settings.
- Click Save page or press Ctrl+S.
- Click Rebuild site to refresh the local website and search index.
LOCAL WORKSPACE
Studio saves files on this computer. Rebuilding refreshes the local preview; it does not publish anything to the internet.
Add a product or a page
Use New product beside Your library to create a collection with its own overview and navigation. Select a collection, then choose New page. The page address is generated from its title and stays stable after creation.
For a new Unreal Engine plugin, choose Plugin documentation · 10 pages in the New product dialog. It generates a reusable guide structure with writing prompts. See Plugin documentation template. Replace the prompts before publishing and enable Include in site search in Page settings when each page is ready. Search exclusion does not make pages private.
Images and tables
Choose Insert image to upload a PNG, JPEG, GIF, or WebP image. Add a useful description so readers know what it shows.
Use Insert table, then select a cell to reveal controls for adding or removing rows and columns. Code blocks keep their language when saved.
Information, tip, warning, and danger boxes
Choose Callout in the formatting toolbar. Pick a style, enter a title and message, then choose Insert callout. The four styles are Information, Tip, Warning, and Danger.
To recreate the compatibility notice, choose Warning, set the title to VERSION COMPATIBILITY, and enter the message below:
VERSION COMPATIBILITY
List only engine versions that the actual product has been tested with. This preview does not claim compatibility with any Unreal Engine version.
Click inside an existing box to change its message directly. The toolbar changes to Edit callout; use it to change the style or title. Multiple paragraphs, lists, links, and code blocks inside a box are preserved.
Drafts and backups
Unsaved edits are kept in this browser. You can switch pages and come back to your draft. Every file save also keeps the previous disk version.
Open Page history to load an earlier version as a draft. Review it and save when ready. If a file changed outside Studio, saving is stopped so a stale draft cannot silently overwrite newer work.
Advanced content
Markdown mode remains available for source editing. Custom layouts, HTML/Vue, details and code-group containers, task lists, footnotes, include directives, and math blocks stay in source mode. Malformed or unclosed containers also stay in source mode so their syntax can be corrected without losing content.
Keep each guide focused on one clear outcome.