MD -a
Open Workspace
User Guides & Docs

How to Use MD-a

A step-by-step user manual to edit, diagram, clean, and convert markdown documents client-side.

1. The Editing Environment

Open the Workspace Editor to access your writing board. The layout splits into two sides:

  • Source Editor (Left): Write raw markdown. The gutter updates line numbers dynamically. Drag and drop local image files from your computer directly into the editor text field to encode them as inline data:image/base64 URLs.
  • Draggable Divider: Click and drag the thin border bar between panels to resize your workspace layout.
  • Toolbar: Access standard formatting helpers (Bold, Italic, Header sizes, Lists, Code blocks, and Tables) from the sticky toolbar header. Click Focus Mode to toggle full-pane editor screen views.

2. Local Document Explorer

MD-a features a built-in file manager powered entirely by client browser LocalStorage:

  • Create Files: Click + New File in the sidebar explorer to initialize a clean file.
  • Rename & Delete: Hover over any item in the explorer sidebar to rename or delete the document.
  • Autosave: Every keystroke automatically updates the document structure in your browser local cache, preventing data loss.

3. Mermaid.js Flowchart Rendering

Write graphs and process structures inline. Put your chart text inside standard code blocks with the language tag mermaid:

```mermaid
graph TD
  A[Start] --> B[Process]
```

The layout automatically intercepts the code container, parses the nodes, and draws a clean SVG diagram on the client-side.

4. Visual Wizards & Helpers

We provide dedicated wizards under the Wizards & Tools header:

  • Table Wizard: Hover over a dimension grid to set rows/columns. Choose column alignments and input cells to compile markdown code blocks instantly.
  • Frontmatter Builder: Input Title, Author, Date, and Description to output clean YAML headers. Press Prepend to Editor to inject the configurations at the top of your workspace document.
  • Sanitizer & Cleaner: Strip custom HTML wrappers, fix lists formatting, and collapse excessive double blank lines from copy-pasted blocks.
  • Link Checker: Scan files to inspect URL structures and locate broken internal section headings.

5. Export & Import Pipelines

In the Converters dashboard:

  • Export Formats: Compile your documents into Standalone HTML, LaTeX blocks, stripped plain text, or Word (.docx) formats.
  • PDF printing: Choose PDF compilation to trigger print layouts, enabling you to save full-page clean PDFs via the browser system dialog.
  • HTML to Markdown Import: Paste rich HTML from platforms like Google Docs, Medium, or Word. Translate structures back into clean, semantic Markdown in seconds.

6. Keyboard Command Palette

Navigate the application instantly without using a mouse. Press Cmd + K (on Mac) or Ctrl + K (on Windows/Linux) to trigger the command search dialog, choose paths, create documents, or copy outputs.