Skip to content

Feature Overview

This page summarizes what you can do in MD Visual MDDocs and how to use it. If you're just getting started, review the quick start below, then explore the features.

Getting Started

New to MD Visual MDDocs? Start with the Quick Start section below, then explore the features that interest you most.

Quick start

  1. Sign in on the Login screen.
  2. After you sign in, the main workspace opens with File Explorer on the left, the document viewer in the center, and the TOC on the right.
  3. Successful login enables Edit and Export where available.
  4. Returning soon after a session will auto-restore your access and last viewed area.
  5. Open a document from the File Explorer.
  6. Click Edit Edit icon to modify; Save when done.
  7. Use the TOC on the right to navigate. Click the Theme Theme icon button in the top-right header to switch light/dark.
  8. See these guides next: Creating or Managing Documentation, Linking Documents to Objects, Exporting Documentation.

Session Management

Your login session is automatically restored if you return soon after leaving. This means you won't need to sign in again for quick return visits.

Login screen to access server-backed documentation:

Login: sign in to start

Browse and manage files

  • Use the left File Explorer to browse repositories, folders, and Markdown documents stored on the server.
  • The sidebar lists all available repositories; each repository can contain multiple folders and files within those folders.
  • Expand folders to navigate, and click a Markdown file to open it in the viewer.
  • When available, use context actions to rename items or create new ones without leaving the page.
  • Resize side panels by dragging their edges to get more reading space.
  • Once a page is open, use the Table of Contents on the right to jump within it.

Navigation Tips

Right-click on folders or files to access context menus with additional actions. You can resize panels by dragging their edges to optimize your workspace.

The left File Explorer lists repositories, folders, and Markdown documents:

File Explorer: repositories, folders, and documents

Switch themes

Theme button Theme icon in the top-right header:

Theme button location

  • Use the Theme Theme icon toggle in the top-right header to switch between light and dark modes.
  • Your choice is remembered for the next visit in the same browser.

Theme Preference

Your theme selection is stored locally in your browser, so it will persist across sessions on the same device.

Toggle between light and dark themes from the header:

Theme: light and dark toggle

Use admonitions (callouts and tips)

  • Important notes are shown as admonitions (for example, Note, Tip, Warning).
  • Read these for context, prerequisites, or cautions while following steps.

Using Admonitions

Admonitions help highlight important information. Use them in your own documents to draw attention to key points, warnings, or helpful tips.

Admonitions highlight key notes, tips, and warnings inline:

Admonitions: note, tip, warning

Work with images

  • Images appear inline with captions or labels where provided.
  • When an image is referenced from the library, it opens quickly without leaving the page.
  • Upload images to the server and insert them directly into your documentation using the built-in image management system.
  • Access uploaded images from the image library for quick insertion without having to leave the editing interface.
  • Configure image attributes like width, height, and styling directly in the markdown syntax for precise control over image display.

Image Management

All images are stored on the server, making them easily accessible for reuse across multiple documents. Use descriptive filenames to help organize your image library.

Search within a page

Use your browser's Find feature to locate keywords quickly.

Quick Navigation

Use Ctrl+F (or Cmd+F on Mac) to search within the current page. The TOC on the right provides quick access to all headings in the document.

Use the TOC to jump to headings within the current page:

TOC: jump within page

Save and export

  • Export your current document as PDF PDF icon or Word Word icon when the actions are available in the header.
  • PDF exports use the red PDF button; Word exports use the blue W button.
  • Files download via your browser so you can share or archive them.

Export Options

Export buttons appear in the header when available. PDF exports preserve the exact layout, while Word exports allow for further editing offline.

Export or download content where the page offers actions:

Export: download actions

Protect your work

  • If you are editing or preparing content in the app, you may see prompts about unsaved changes before leaving a page.
  • Rename and confirmation dialogs help you avoid accidental changes.
  • The system displays confirmation dialogs to prevent accidental loss of your work when navigating away with unsaved edits.

Save Your Work

Always save your changes before navigating away from a page. The system will warn you about unsaved changes, but it's best practice to save frequently.

Staying signed in (if login is enabled)

  • Sign in once to start working. If you return soon, the app will sign you in automatically.
  • If your session expires, you will be asked to sign in again.

Session Security

Your session will automatically expire after a period of inactivity for security. Simply sign in again to continue working.

What to expect from formatting

  • Admonitions: clear callouts for notes, tips, and warnings.
  • Formatted tables: tables render with borders and headings.
  • Formatted headings: consistent styles across levels (H1–H4) improve scannability.
  • Code snippets: fenced code blocks render with syntax highlighting.