/staruml-markdown

Markdown Documentation

Primary LanguageJavaScriptMIT LicenseMIT

Markdown

This extension allow to use Markdown syntax for documentation.

Installation

Open Extension Manager (Tools > Extension Manager) and select Registry Tab and enter "markdown" in search box. You can find Markdown extension and then click install button.

Usage

To show Markdown editor, select View > Markdown Documentation (Alt+Ctrl+D) or click Markdown icon in Toolbar.

The Markdown documentation editor support two modes: Edit mode and Preview mode.

Edit mode

Click "Edit" button, you can edit documentation of a selected element with support of Markdown syntax coloring.

Edit mode

Preview mode

Click "Preview" button, you can see the preview of Markdown documentation of a selected element.

Preview mode


Licensed under the MIT license (see LICENSE file).