Skip to content

Write with Auralis Studio ​

Use the local visual editor to write and organize your documentation. Every product shares the same design while keeping its own collection and navigation. You can work without writing Markdown by hand.

The everyday workflow ​

  1. Start Auralis Studio on your computer.
  2. Choose a collection and a page from the library.
  3. Write in Visual mode and use the formatting toolbar.
  4. Choose Save page, then Rebuild site to refresh the local preview.

Read Using Auralis Studio for images, tables, new pages, product settings, drafts, and backups.

Create content from the panel ​

Use New page to add a guide to the selected collection. Use New product to create a separate product collection with an overview page and a home-page card. Change the card text in Product settings and the reading order in Page settings.

Working directly with files ​

The visual editor saves ordinary Markdown files. You can still use a text editor when you prefer it, or choose Markdown mode inside Studio for advanced content.

Add a page manually ​

Create a Markdown file in the relevant product folder:

markdown
---
title: Product Name — New guide
description: Explain what the guide covers in one sentence.
---

# New guide

Tell readers what they will be able to do by the end.

## First step

Describe the action and its expected result together.

Then add it to the relevant product group in docs/.vitepress/content.json. Its path must match the content file. Studio manages this registry automatically when creating pages.

Add a product manually ​

  1. Create a unique folder inside docs/products/.
  2. Write overview, installation, and quick start pages.
  3. Add the product and its page groups to docs/.vitepress/content.json.
  4. Keep its ID, page paths, and menu labels consistent.
  5. The product card's guide count is calculated from its navigation entries.

The library and the product selector share the same product records. The sidebar defines the reading order.

Store images in docs/public/images/. Use lowercase, hyphenated filenames and descriptive alternative text. Relative links between Markdown files make content easier to maintain.

Preview and check ​

sh
npm run docs:dev
npm run docs:check
npm run docs:build

The content check validates local Markdown links and image paths. The build generates pages and the search index. A successful build does not verify every user interaction; try navigation and search in the browser too.

Multiple products. One knowledge base.