Skip to content

Commit

Permalink
updated mermaidjs.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HariSekhon committed Oct 9, 2024
1 parent 7230f34 commit 0534f1f
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions mermaidjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@
<https://mermaid.js.org/>

<!-- INDEX_START -->

- [Live Online Interactive Editor](#live-online-interactive-editor)
- [CLI](#cli)
- [Install CLI](#install-cli)
- [Convert `.mmd` code file into a diagram](#convert-mmd-code-file-into-a-diagram)
- [Real World Examples](#real-world-examples)
- [GitHub Flow with Jira ticket integration](#github-flow-with-jira-ticket-integration)
- [Git - why you shouldn't use long-lived feature branches](#git---why-you-shouldnt-use-long-lived-feature-branches)
- [Gantt Chart of my Experience](#gantt-chart-of-my-experience)
- [Gantt Chart of my GitHub Repos](#gantt-chart-of-my-github-repos)

<!-- INDEX_END -->

Excellent [Diagrams-as-Code](diagrams.md) tool with the widest variety of formats and structures
Expand Down Expand Up @@ -39,6 +50,18 @@ Comes with a range of sample diagrams to get you started that you can modify int

This can compile local `.mmd` code into svg or png graphs.

### Install CLI

```shell
npm install -g @mermaid-js/mermaid-cli
```

### Convert `.mmd` code file into a diagram

```shell
mmdc -i input.mmd -o output.svg
```

## Real World Examples

Also available in the :octocat: [HariSekhon/Diagrams-as-Code](https://github.com/HariSekhon/Diagrams-as-Code)
Expand Down

0 comments on commit 0534f1f

Please # to comment.