🎩 You're Invited:Meet the Socket team at Black Hat in Las Vegas, August 3-6.RSVP
Sign In

mermaid-previewer

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mermaid-previewer

Simple CLI tool for previewing live edits to Mermaid.js Diagrams

latest
Source
npmnpm
Version
0.1.1
Version published
Weekly downloads
6
-33.33%
Maintainers
1
Weekly downloads
 
Created
Source

mermaid-previewer

version license

Basic CLI tool for previewing live edits to Mermaid.js Diagrams

Mermaid preview cli tool screen recording

Installation

To install the CLI tool using NPM:

npm install -g mermaid-previewer

Usage

mermaid <diagram file>

The <diagram file> is a required option which should simply be the name of the .mmd Mermaid.js Diagram file.

The .mmd file extension is required.

Running the CLI tool will open a local preview server, displaying the diagram preview in the browser. Any changes to the target diagram file will automatically refresh the preview.

The preview also includes an 'Export' button. Clicking this will export the diagram to the same location as the original target diagram file as a JPEG.

CLI Options

--port: Sets the preview server port (default: 9510)

--help: Displays the help output

--version: Displays the current version

Contributing

Pull Requests are welcome! Check out the CONTRIBUTING.md file for project details.

License

MIT

Keywords

mermaid

FAQs

Package last updated on 24 Oct 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts