DocMD for VS Code is the primary interactive frontend for the DocMD ecosystem.
The extension does not own document import or render logic directly. It invokes
the local docmd runtime and turns those workflows into editor-native commands.
Runtime Installation
End users do not need to preinstall the CLI manually.
- Install the extension.
- Run
DocMD: Import File,DocMD: Render File,DocMD: Run Doctor, orDocMD: Install CLI. - If the runtime is missing, the extension offers to download the latest GitHub release and retry the command.
Managed install locations:
- Windows:
%LOCALAPPDATA%\docmd\bin\docmd.exe - Linux:
~/.docmd/bin/docmd
Module Layout
src/corewires activation and shared services.src/modulescontains user-facing modules such as doctor, import, and render.src/infrastructurecontains concrete adapters such as thedocmdprocess wrapper and output logging.src/sharedcontains reusable helpers and error presentation.
Local Testing
Use the extension from VS Code's Extension Development Host:
- Open the repository root in VS Code so the workspace uses the root
.vscodelaunch and task configuration. - Install dependencies in this folder with
npm install. - Ensure the local toolchain is available:
dartfor the sibling CLI in../clipandocfor DOCX import and DOCX exportsofficeor LibreOffice for PDF export
- Run the
Run Extensionlaunch configuration with F5 from the repository root window. - In the Extension Development Host, run
DocMD: Run Doctorfrom the Command Palette. - Run
DocMD: Import File, choose a.docx, and wait for the editor webview to open. - Edit the Markdown in the left pane and press
Save. - Use
Open Rawto verify the persistedcontent/document.mdfile. - Use
Export DOCXorExport PDFin the editor toolbar, or runDocMD: Render File.
During local development the extension resolves the CLI in this order:
DOCMD_CLI_PATHwhen explicitly set../cli/build/bin/docmd(.exe)when a local build existsdart run bin/main.dartfrom the sibling../cliproject- the managed install directory used by
DocMD: Install CLI docmdfrom the systemPATH