vscode-pandoc installs statistics

vscode-pandoc

The vscode-pandoc Visual Studio Code extension lets you convert Markdown and other supported source documents into 29 output formats, including PDF, Word, HTML, EPUB, and PowerPoint.

Thanks to the previous work of @dfinke on this extension.

Features

• Render the active document to any of 29 output formats from the Command Palette or a keybinding. • Per-format Pandoc argument strings, plus optional in-file pandoc_args frontmatter. • Render on save, with per-language scoping. • Named profiles for switching whole option sets per client or project. • Per-document reference templates for docx, odt, and pptx. • Built-in admonition rendering (:::note, :::warning, …) via a bundled Lua filter, plus support for your own Lua filters. • Optional Docker mode with hardened container defaults. • A configurable output folder, render timeout, and auto-open of the result.

Commands

Run these from the Command Palette (_F1_ / _shift+cmd+P_):

| Command | Description |

| Pandoc Render | Render the active document. Bound to _ctrl+K P_ (_cmd+K P_ on Mac). | | Pandoc: Select Profile | Choose the active profile for the workspace, or "Default" to use base settings. |

Prerequisites

You need Visual Studio Code 1.110 or newer to run the extension.

You need to install Pandoc - a universal document converter.

By default, Pandoc creates PDFs using LaTeX. If you want to use the extension for rendering PDFs, you also need to install a PDF engine. Recommendations are:

• macOS: BasicTeX • Windows: MiKTeX • Linux: TeX Live

Usage

Pandoc can convert many different file formats to another, but not all work to and from each other. For example, most relevant to this extension, Pandoc can convert from Markdown to most other formats, but can only convert to AsciiDoc. Read the full list for more details on supported conversion formats.

There are two ways to run the extension. You need to have a supported file open.

1. Press _F1_ on Windows or _shift+cmd+P_ on Mac, type "pandoc", press _Enter_. 2. Press the key combination _ctrl+K_ then _P_ or _cmd+K_ then _P_ on Mac.

Choose from the list the document type you want to render and hit _enter_ (you can also type in the box rather than cursor around).

Pandoc reads local files from disk, so the extension only works on saved documents in a real folder (not untitled buffers or virtual filesystems). If the document has unsaved changes, the extension saves it after you pick the format, then renders.

Rendering shows a cancellable progress notification. It times out after five minutes by default (pandoc.render.timeout), and a second render to the same output waits for or is rejected until the first finishes.

By default, the extension saves the rendered file next to the source file, with the same name and an extension matching the format you picked (e.g. _notes.md_ -> _notes.html_). Read Set the output folder to change this. When rendering succeeds, the extension also opens the result in its default viewer automatically (pandoc.render.openViewer, on by default). Set it to false to disable this. If that step itself fails (no application associated with the file type, for example), a warning notification says so rather than failing silently.

Supported output formats

Use the format identifier below for pandoc.defaultOutputFormat or a keybinding's outputType. Each format has its own setting for additional Pandoc arguments.

| Format identifier | Output extension | Options setting |

| pdf | .pdf | pandoc.pdfOptString | | docx | .docx | pandoc.docxOptString | | html | .html | pandoc.htmlOptString | | asciidoc | .adoc | pandoc.asciidocOptString | | docbook | .xml | pandoc.docbookOptString | | epub | .epub | pandoc.epubOptString | | rst | .rst | pandoc.rstOptString | | odt | .odt | pandoc.odtOptString | | pptx | .pptx | pandoc.pptxOptString | | latex | .tex | pandoc.latexOptString | | beamer | .tex | pandoc.beamerOptString | | rtf | .rtf | pandoc.rtfOptString | | org | .org | pandoc.orgOptString | | mediawiki | .mediawiki | pandoc.mediawikiOptString | | textile | .textile | pandoc.textileOptString | | dokuwiki | .dokuwiki | pandoc.dokuwikiOptString | | jira | .jira | pandoc.jiraOptString | | ipynb | .ipynb | pandoc.ipynbOptString | | typst | .typ | pandoc.typstOptString | | plain | .txt | pandoc.plainOptString | | gfm | .md | pandoc.gfmOptString | | commonmark | .md | pandoc.commonmarkOptString | | opml | .opml | pandoc.opmlOptString | | icml | .icml | pandoc.icmlOptString | | jats | .xml | pandoc.jatsOptString | | man | .man | pandoc.manOptString | | texinfo | .texi | pandoc.texinfoOptString | | fb2 | .fb2 | pandoc.fb2OptString | | revealjs | .html | pandoc.revealjsOptString |

Settings

Override these options in the Pandoc extension settings section, or find pandoc in _settings.json_ and set the options.

Override the default executable

Override this in the Pandoc extension settings section, or find pandoc in _settings.json_ and set the options.

• Executable / pandoc.executable: Path to the Pandoc executable. • Default: Gets the path from the system's PATH variable.

The extension calls Pandoc directly, using the PATH VS Code's own process has. It doesn't see shell aliases or PATH edits that only apply to interactive shells (asdf/nvm version managers, brew shellenv, etc.). If pandoc: command not found appears in the Pandoc output channel despite pandoc working in your terminal, set pandoc.executable to the absolute path from which pandoc (macOS/Linux) or where.exe pandoc (Windows).

Set the default output format

To set a default export format and bypass the format list prompt, set the pandoc.defaultOutputFormat option in the settings.

The extension accepts only the formats in the format picker. If you set pandoc.defaultOutputFormat to anything else, the extension shows an error instead of rendering.

Render on save…

Description from the VS Code Marketplace listing.