Autype for VS Code is a focused authoring companion, not a replacement for the Autype platform. Content stays in human-readable Extended Markdown (MD+); a small autype.json supplies document settings, variables, and optional reusable styling. Rendering and validation use the Autype Developer API.
Features
- PDF preview beside the editor
- strict V2 validation with issues in VS Code Problems
- PDF, DOCX, and ODT export
- current MD+ syntax highlighting in
.md and .mdd files
- variables, citations, footnotes, task lists, layouts, canvas content, forms, charts, references, and generated indexes
- local image upload with caching and project-boundary protection
- reusable V2 styles through
stylePresetId
- API keys stored in VS Code SecretStorage
Requirements
You need an Autype API key whose organization can use the Developer API. Export availability and automation usage are determined by the current Autype entitlements and credit balance; the extension does not hard-code plan names or limits.
Create and manage API keys in app.autype.com. The key must include:
read:documents
render:documents
manage:files when local images are used
Getting started
Create a folder containing Markdown and its companion configuration:
my-document/
├── autype.json
├── document.md
└── images/
└── logo.png
You can also right-click a folder and select Autype: Create New Document.
Minimal autype.json:
{
"document": {
"type": "pdf",
"size": "A4",
"orientation": "portrait",
"language": "en-US"
},
"variables": {
"companyName": "Acme Inc."
}
}
To use a reusable built-in or workspace style, add its exact reference:
{
"document": {
"type": "pdf",
"size": "A4",
"language": "en-US"
},
"stylePresetId": "system:executive-annual-report"
}
Inline defaults and style remain supported for deliberate overrides, but V2 recommends reusable styles and minimal local styling.
Then:
- Run
Autype: Set API Key. The key is verified before it is saved.
- Open
document.md or document.mdd.
- Run
Autype: Validate Document and review any Problems entries.
- Run
Autype: Show Preview or click the Autype editor action.
- Export as PDF, DOCX, or ODT.
MD+ examples
Standard Markdown remains valid. Autype MD+ adds document semantics when needed.
# Quarterly Review {#quarterly-review}
Prepared for **{{companyName}}**.
- [x] Data verified
- [ ] Final approval received
The result is independently reviewed[^review].
[^review]: Review record from 25 August 2026.
::toc{title="Contents" maxLevel=3}
---layout{gap=12 keepTogether=true}---
---column{width="1fr"}---
## Summary
Editable content remains normal MD+.
---/column---
---column{width="1fr"}---
{width=280 align=center}
---/column---
---/layout---
:::chart{type="bar" title="Revenue"}
labels: Q1, Q2, Q3
dataset: 2026 | 120, 155, 190 | #29a46b
:::
See [Quarterly Review](#quarterly-review).
Use fixed canvas only for deliberately positioned designs such as covers or certificates. Use semantic layouts for editable side-by-side content, and normal Markdown for ordinary document flow.
Configuration
VS Code validates autype.json while you edit it. The supported top-level V2 fields are:
document
stylePresetId
variables
abbreviations
defaults
citations
style
pdfProfile
webhook
sections and footnotes for the advanced JSON-sections mode
For MD+ documents, footnote definitions belong in the Markdown rather than autype.json.
Supported PDF profiles are standard, pdfa-1b, pdfa-2b, pdfa-3b, and pdfua-1. PDF profiles only apply to PDF output.
Commands
| Command |
Description |
Autype: Show Preview |
Open the PDF preview panel |
Autype: Render Document |
Render the current MD+ document |
Autype: Validate Document |
Validate MD+ and configuration and update Problems |
Autype: Export as PDF |
Validate and export PDF |
Autype: Export as DOCX |
Validate and export DOCX |
Autype: Export as ODT |
Validate and export ODT |
Autype: Clean Image Cache |
Force local images to upload again |
Autype: Create New Document |
Create a minimal MD+-first project |
Autype: Set API Key |
Verify and securely store an API key |
Autype: Remove API Key |
Remove the stored API key |
Settings
| Setting |
Default |
Description |
autype.apiBaseUrl |
https://api.autype.com/api/v1/dev |
Autype Developer API base URL |
autype.toolbar.visible |
true |
Show the optional insert toolbar |
autype.toolbar.iconSize |
small |
small, medium, or large |
Notes
autype.json and its Markdown file currently belong in the same folder.
- If the configuration is opened first, the extension discovers
document.mdd, document.md, or the single Markdown file in that folder.
- When multiple non-standard Markdown files exist, open the intended file before rendering.
- Preview rendering is watermarked. Export billing and format permissions are enforced by the API.
- Local image references must stay inside the document project folder.
Links
License
Proprietary — see LICENSE.