diff --git a/README.md b/README.md
index 16ebd21..036d730 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@
# What is markdown package
The Package markdown is a simple markdown builder in golang. The markdown package assembles Markdown using method chaining, not uses a template engine like [html/template](https://pkg.go.dev/html/template). The syntax of Markdown follows **GitHub Markdown**.
-The markdown package was initially developed to save test results in [nao1215/spectest](https://github.com/nao1215/spectest). Therefore, the markdown package implements the features required by spectest. For example, the markdown package supports **mermaid sequence diagrams (entity relationship diagram, sequence diagram, pie chart)**, which was a necessary feature in spectest.
+The markdown package was initially developed to save test results in [nao1215/spectest](https://github.com/nao1215/spectest). Therefore, the markdown package implements the features required by spectest. For example, the markdown package supports **mermaid sequence diagrams (entity relationship diagram, sequence diagram, flowchart, pie chart)**, which was a necessary feature in spectest.
Additionally, complex code that increases the complexity of the library, such as generating nested lists, will not be added. I want to keep this library as simple as possible.
@@ -34,6 +34,7 @@ Additionally, complex code that increases the complexity of the library, such as
- [x] Alerts; NOTE, TIP, IMPORTANT, CAUTION, WARNING
- [x] mermaid sequence diagram
- [x] mermaid entity relationship diagram
+- [x] mermaid flowchart
- [x] mermaid pie chart
### Features not in Markdown syntax
@@ -165,6 +166,7 @@ func main() {
if err != nil {
panic(err)
}
+ defer f.Close()
md.NewMarkdown(f).
H1("go generate example").
@@ -366,6 +368,7 @@ func main() {
if err != nil {
panic(err)
}
+ defer f.Close()
teachers := er.NewEntity(
"teachers",
@@ -523,6 +526,86 @@ erDiagram
}
```
+### Flowchart syntax
+
+```go
+package main
+
+import (
+ "io"
+ "os"
+
+ "github.com/nao1215/markdown"
+ "github.com/nao1215/markdown/mermaid/flowchart"
+)
+
+//go:generate go run main.go
+
+func main() {
+ f, err := os.Create("generated.md")
+ if err != nil {
+ panic(err)
+ }
+ defer f.Close()
+
+ fc := flowchart.NewFlowchart(
+ io.Discard,
+ flowchart.WithTitle("mermaid flowchart builder"),
+ flowchart.WithOrientalTopToBottom(),
+ ).
+ NodeWithText("A", "Node A").
+ StadiumNode("B", "Node B").
+ SubroutineNode("C", "Node C").
+ DatabaseNode("D", "Database").
+ LinkWithArrowHead("A", "B").
+ LinkWithArrowHeadAndText("B", "D", "send original data").
+ LinkWithArrowHead("B", "C").
+ DottedLinkWithText("C", "D", "send filtered data").
+ String()
+
+ err = markdown.NewMarkdown(f).
+ H2("Flowchart").
+ CodeBlocks(markdown.SyntaxHighlightMermaid, fc).
+ Build()
+
+ if err != nil {
+ panic(err)
+ }
+}
+```
+
+Plain text output: [markdown is here](./doc/flowchart/generated.md)
+````
+## Flowchart
+```mermaid
+---
+title: mermaid flowchart builder
+---
+flowchart TB
+ A["Node A"]
+ B(["Node B"])
+ C[["Node C"]]
+ D[("Database")]
+ A-->B
+ B-->|"send original data"|D
+ B-->C
+ C-. "send filtered data" .-> D
+```
+````
+
+Mermaid output:
+```mermaid
+flowchart TB
+ A["Node A"]
+ B(["Node B"])
+ C[["Node C"]]
+ D[("Database")]
+ A-->B
+ B-->|"send original data"|D
+ B-->C
+ C-. "send filtered data" .-> D
+```
+
### Pie chart syntax
```go
@@ -543,6 +626,7 @@ func main() {
if err != nil {
panic(err)
}
+ defer f.Close()
chart := piechart.NewPieChart(
io.Discard,
diff --git a/doc/alert/main.go b/doc/alert/main.go
index abfc534..154d410 100644
--- a/doc/alert/main.go
+++ b/doc/alert/main.go
@@ -16,6 +16,7 @@ func main() {
if err != nil {
panic(err)
}
+ defer f.Close()
if err := md.NewMarkdown(f).
H1("Alert example").
diff --git a/doc/badge/main.go b/doc/badge/main.go
index daea9ea..7939449 100644
--- a/doc/badge/main.go
+++ b/doc/badge/main.go
@@ -16,6 +16,7 @@ func main() {
if err != nil {
panic(err)
}
+ defer f.Close()
if err := md.NewMarkdown(f).
H1("badge example").
diff --git a/doc/er/main.go b/doc/er/main.go
index a7ac35b..6619f73 100644
--- a/doc/er/main.go
+++ b/doc/er/main.go
@@ -17,6 +17,7 @@ func main() {
if err != nil {
panic(err)
}
+ defer f.Close()
teachers := er.NewEntity(
"teachers",
diff --git a/doc/flowchart/generated.md b/doc/flowchart/generated.md
new file mode 100644
index 0000000..e4c1ca2
--- /dev/null
+++ b/doc/flowchart/generated.md
@@ -0,0 +1,15 @@
+## Flowchart
+```mermaid
+---
+title: mermaid flowchart builder
+---
+flowchart TB
+ A["Node A"]
+ B(["Node B"])
+ C[["Node C"]]
+ D[("Database")]
+ A-->B
+ B-->|"send original data"|D
+ B-->C
+ C-. "send filtered data" .-> D
+```
\ No newline at end of file
diff --git a/doc/flowchart/main.go b/doc/flowchart/main.go
new file mode 100644
index 0000000..64a3f1e
--- /dev/null
+++ b/doc/flowchart/main.go
@@ -0,0 +1,46 @@
+//go:build linux || darwin
+
+// Package main is generating flowchart.
+package main
+
+import (
+ "io"
+ "os"
+
+ "github.com/nao1215/markdown"
+ "github.com/nao1215/markdown/mermaid/flowchart"
+)
+
+//go:generate go run main.go
+
+func main() {
+ f, err := os.Create("generated.md")
+ if err != nil {
+ panic(err)
+ }
+ defer f.Close()
+
+ fc := flowchart.NewFlowchart(
+ io.Discard,
+ flowchart.WithTitle("mermaid flowchart builder"),
+ flowchart.WithOrientalTopToBottom(),
+ ).
+ NodeWithText("A", "Node A").
+ StadiumNode("B", "Node B").
+ SubroutineNode("C", "Node C").
+ DatabaseNode("D", "Database").
+ LinkWithArrowHead("A", "B").
+ LinkWithArrowHeadAndText("B", "D", "send original data").
+ LinkWithArrowHead("B", "C").
+ DottedLinkWithText("C", "D", "send filtered data").
+ String()
+
+ err = markdown.NewMarkdown(f).
+ H2("Flowchart").
+ CodeBlocks(markdown.SyntaxHighlightMermaid, fc).
+ Build()
+
+ if err != nil {
+ panic(err)
+ }
+}
diff --git a/doc/generate/main.go b/doc/generate/main.go
index a1e5d64..57a9b4c 100644
--- a/doc/generate/main.go
+++ b/doc/generate/main.go
@@ -16,6 +16,7 @@ func main() {
if err != nil {
panic(err)
}
+ defer f.Close()
if err := md.NewMarkdown(f).
H1("go generate example").
diff --git a/doc/piechart/main.go b/doc/piechart/main.go
index 6e5ae67..f61cede 100644
--- a/doc/piechart/main.go
+++ b/doc/piechart/main.go
@@ -18,6 +18,7 @@ func main() {
if err != nil {
panic(err)
}
+ defer f.Close()
chart := piechart.NewPieChart(
io.Discard,
diff --git a/doc/sequence/main.go b/doc/sequence/main.go
index 740fb1d..d76ef63 100644
--- a/doc/sequence/main.go
+++ b/doc/sequence/main.go
@@ -18,6 +18,7 @@ func main() {
if err != nil {
panic(err)
}
+ defer f.Close()
diagram := sequence.NewDiagram(io.Discard).
Participant("Sophia").
diff --git a/internal/lf.go b/internal/lf.go
new file mode 100644
index 0000000..935870d
--- /dev/null
+++ b/internal/lf.go
@@ -0,0 +1,12 @@
+// Package internal package is used to store the internal implementation of the mermaid package.
+package internal
+
+import "runtime"
+
+// LineFeed return line feed for current OS.
+func LineFeed() string {
+ if runtime.GOOS == "windows" {
+ return "\r\n"
+ }
+ return "\n"
+}
diff --git a/internal/lf_test.go b/internal/lf_test.go
new file mode 100644
index 0000000..122dea4
--- /dev/null
+++ b/internal/lf_test.go
@@ -0,0 +1,28 @@
+// Package internal package is used to store the internal implementation of the mermaid package.
+package internal
+
+import (
+ "runtime"
+ "testing"
+)
+
+func TestLineFeed(t *testing.T) {
+ t.Parallel()
+
+ t.Run("should return line feed for current OS", func(t *testing.T) {
+ t.Parallel()
+
+ got := LineFeed()
+
+ switch runtime.GOOS {
+ case "windows":
+ if got != "\r\n" {
+ t.Errorf("expected \\r\\n, but got %s", got)
+ }
+ default:
+ if got != "\n" {
+ t.Errorf("expected \\n, but got %s", got)
+ }
+ }
+ })
+}
diff --git a/markdown.go b/markdown.go
index 592438d..76570c2 100644
--- a/markdown.go
+++ b/markdown.go
@@ -4,9 +4,9 @@ package markdown
import (
"fmt"
"io"
- "runtime"
"strings"
+ "github.com/nao1215/markdown/internal"
"github.com/olekukonko/tablewriter"
)
@@ -126,7 +126,7 @@ func NewMarkdown(w io.Writer) *Markdown {
// String returns markdown text.
func (m *Markdown) String() string {
- return strings.Join(m.body, lineFeed())
+ return strings.Join(m.body, internal.LineFeed())
}
// Error returns error.
@@ -238,7 +238,8 @@ func (m *Markdown) H6f(format string, args ...interface{}) *Markdown {
func (m *Markdown) Details(summary, text string) *Markdown {
m.body = append(
m.body,
- fmt.Sprintf("%s
%s%s%s%s
%s%s%sHello
%sGood World%sHello
%sGood World%s