@mermaid-js/mermaid-cli 9.2.2 → 9.4.0

package/README.md

@@ -1,20 +1,37 @@
 # mermaid-cli
 
+[![npm version](https://img.shields.io/npm/v/@mermaid-js/mermaid-cli)](https://www.npmjs.com/package/@mermaid-js/mermaid-cli)
+[![node-lts (scoped)](https://img.shields.io/node/v-lts/@mermaid-js/mermaid-cli)](https://www.npmjs.com/package/@mermaid-js/mermaid-cli)
+[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/minlag/mermaid-cli?label=Dockerhub)](https://hub.docker.com/r/minlag/mermaid-cli)
+[![Build, test and deploy mermaid-cli Docker image](https://github.com/mermaid-js/mermaid-cli/actions/workflows/compile-mermaid.yml/badge.svg)](https://github.com/mermaid-js/mermaid-cli/actions/workflows/compile-mermaid.yml)
+[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Mermaid/mermaid-cli)
+[![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
+
 This is a command-line interface (CLI) for [mermaid](https://mermaid-js.github.io/). It takes a mermaid definition file as input and generates an svg/png/pdf file as output.
 
-[![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Mermaid/mermaid-cli) ![Build, test and deploy](https://github.com/mermaid-js/mermaid-cli/workflows/Build,%20test%20and%20deploy%20mermaid-cli%20Docker%20image/badge.svg)
+## Installation
 
-## Example Usage
+```sh
+npm install -g @mermaid-js/mermaid-cli
+```
 
-Locate how to call the mmdc executable for your preferred method i.e. Docker,
-Yarn, NPM, global install, etc. Try these examples to get started quickly.
+## Usage
 
-### Convert Mermaid mmd Diagram File To SVG
+Convert Mermaid mmd Diagram File To SVG
 
 ```sh
 mmdc -i input.mmd -o output.svg
 ```
 
+> **Note**
+>
+> See [Alternative installations](#alternative-installations) if you don't want to install the package globally.
+>
+> Locate how to call the mmdc executable for your preferred method
+> i.e. Docker, Yarn, NPM, local install, etc.
+
+## Examples
+
 ### Create A PNG With A Dark Theme And Transparent Background
 
 ```sh
@@ -92,7 +109,7 @@ You can easily pipe input from stdin. This example shows how to use a heredoc to
 send a diagram as stdin to mermaid-cli (mmdc).
 
 ```sh
-cat << EOF  | mmdc
+cat << EOF  | mmdc --input -
     graph TD
     A[Client] --> B[Load Balancer]
 EOF
@@ -104,6 +121,8 @@ EOF
 mmdc -h
 ```
 
+# Alternative installations
+
 ## Use Docker:
 
 ```sh
@@ -112,7 +131,7 @@ docker pull minlag/mermaid-cli
 
 or pull from Github Container Registry
 
-```sh 
+```sh
 docker pull ghcr.io/mermaid-js/mermaid-cli/mermaid-cli
 ```
 
@@ -127,9 +146,17 @@ diagram defined on your system in `/path/to/diagrams/diagram.mmd`, you can use
 the container to generate an SVG file as follows:
 
 ```sh
-docker run -it -v /path/to/diagrams:/data minlag/mermaid-cli -i /data/diagram.mmd
+docker run --rm -u `id -u`:`id -g` -v /path/to/diagrams:/data minlag/mermaid-cli -i diagram.mmd
+```
+
+In previous version, the input files were mounted in `/home/mermaidcli`. You can
+restore this behaviour with the `--workdir` option:
+
+```sh
+docker run [...] --workdir=/home/mermaidcli minlag/mermaid-cli [...]
 ```
 
+
 ## Use Node.JS API
 
 It's possible to call `mermaid-cli` via a Node.JS API.
@@ -161,21 +188,6 @@ npm install @mermaid-js/mermaid-cli
 ./node_modules/.bin/mmdc -h
 ```
 
-## Install globally
-
-❗️ We do **NOT** recommend installing it globally because both YARN and NPM
-could fail to install a command-line tool globally properly due to weird
-permission issues.
-`yarn global add @mermaid-js/mermaid-cli` or `npm install -g @mermaid-js/mermaid-cli`
-
-## Install with [brew](https://brew.sh)
-This method of installation is no longer supported.
-For more details, see the [discussion](https://github.com/mermaid-js/mermaid-cli/issues/288).
-An old version of mermaid-cli can be installed with brew.
-```
-brew install mermaid-cli
-```
-
 ### Run with npx
 
 [`npx`](https://www.npmjs.com/package/npx) is installed by default with NPM. It
@@ -183,6 +195,19 @@ downloads and runs commands at the same time.  To use Mermaid CLI with npx, you
 need to use the `-p` flag because the package name is different than the command
 it installs (`mmdc`).  `npx -p @mermaid-js/mermaid-cli mmdc -h`
 
+
+## Install with [brew](https://brew.sh)
+
+> **Warning**
+>
+> This method of installation is no longer supported.
+> For more details, see the [discussion](https://github.com/mermaid-js/mermaid-cli/issues/288).
+> An old version of mermaid-cli can be installed with brew.
+> ```sh
+> brew install mermaid-cli
+> ```
+
+
 ## Known issues
 
 1. [Linux sandbox issue](docs/linux-sandbox-issue.md)