Visual Studuo Code extension: converts Markdown files and saves them as HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
images
out
.gitignore
CHANGELOG.md
LICENSE.txt
README.md
package.json

README.md

Extensible Markdown Converter

Latest Release

This package is the Visual Studio Code extension supporting Markdown. The extension depends on the built-in extension "VS Code Markdown" and adds important function: it reads Markdown content from a currently active editor and converts to an HTML file.

Since v. 2.0.0, the user can extend Markdown features by installing any of the "markdown-it" plug-ins that are abundantly available in the npm package registry. All the packages can be configured from a single source: "settings.json", on the user or workspace level.

That said, there is no a need for different Markdown extensions. It's quite enough to have only the built-in extension combined with Extensible Markdown Converter. All required functionality can be assembled from available plug-ins using the single unified configuration design.

See detailed documentation.

Features

  • Conversion of individual file or all Markdown files of the current Visual Studio Code workspace;
  • A possibility of installation of "markdown-it" plug-ins in an arbitrary directory, without the need to install "markdown-it" itself;
  • Optional user-configurable auto-numbering with rich set of options;
  • User-configurable Markup syntax coloring for plug-ins;
  • Optional embedding of CSS in HTML;
  • Optional Detection of the document title based on user-configurable Regular Expression;
  • Optional preview in the default Web browser;
  • Preview in Visual Studio Code, in a full-size window or side by side, with styles fully matching generated HTML file;
  • Configuration of all processing detail of the extension, "markdown-it" and its plug-ins, from a single source.

Usage

Open Markdown file (.md) in Visual Studio Code and activate the editor's context menu, use the command "Markdown: Convert to HTML", to convert this file. All files found in a currently opened workspace can be converted at once with the command "Markdown: Convert to HTML all .md files in workspace". This command appears in context menu of any editor, and also in the Explorer context menu.

Two more commands showing in the editor's context menu show HTML preview using all of the extended features: Markdown: Open Preview (Ctrl+Shift+V) and Markdown: Open Preview to the Side (Ctrl+K V).

Alternatively, open the Command Palette ("Ctrl+Shift+P"/"Cmd+Shift+P" or F1) and search for the these commands.

Settings

The user can set up the extension of three levels: 1) general behavior of the commands, 2) detail of Markdown parsing and HTML production rules, 3) plug-ins options. The user can install additional plug-ins. If a plug-in has its own options, they are transparently passed from user or workspace "settings.json" to the plug-in.

For detailed specifications, see the documentation.

Credits

The embedded markdown-it was developed based on the study of two existing plug-ins. Even though there are almost no traces of the code of these contributions, they helped to learn some basic techniques: