Skip to content

Commit 257dc46

Browse files
authored
Update README.md to show Mermaid example
1 parent 1783cd6 commit 257dc46

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,57 @@ list of prefixes:
7474

7575
Here's some example output for godepgraph itself:
7676

77+
Using `godepgraph -format mermaid github.com/kisielk/godepgraph`:
78+
79+
```mermaid
80+
flowchart TD
81+
82+
classDef goroot fill:#1D4,color:white
83+
classDef cgofiles fill:#D52,color:white
84+
classDef vendored fill:#D90,color:white
85+
classDef buildErrs fill:#C10,color:white
86+
87+
1[flag]
88+
click 1 href "https://godoc.org/flag"
89+
class 1 goroot
90+
91+
2[fmt]
92+
click 2 href "https://godoc.org/fmt"
93+
class 2 goroot
94+
95+
3[github.com/kisielk/godepgraph]
96+
click 3 href "https://godoc.org/github.com/kisielk/godepgraph"
97+
3 --> 1
98+
3 --> 2
99+
3 --> 4
100+
3 --> 5
101+
3 --> 6
102+
3 --> 7
103+
3 --> 8
104+
105+
4[go/build]
106+
click 4 href "https://godoc.org/go/build"
107+
class 4 goroot
108+
109+
5[log]
110+
click 5 href "https://godoc.org/log"
111+
class 5 goroot
112+
113+
6[os]
114+
click 6 href "https://godoc.org/os"
115+
class 6 goroot
116+
117+
7[sort]
118+
click 7 href "https://godoc.org/sort"
119+
class 7 goroot
120+
121+
8[strings]
122+
click 8 href "https://godoc.org/strings"
123+
class 8 goroot
124+
```
125+
126+
Using `godepgraph -format graphviz github.com/kisielk/godepgraph`:
127+
77128
![Example output](example.png)
78129

79130
[graphviz]: http://graphviz.org

0 commit comments

Comments
 (0)