{"repo":"nao1215/markdown","free":true,"listed":false,"github":"https://github.com/nao1215/markdown","clone":"git clone https://github.com/nao1215/markdown.git","description":"simple markdown & mermaid builder in golang","language":"Go","stars":139,"topics":["builder","golang","markdown","markdown-buider","entity-relationship-diagram","mermaid","pie-chart","sequence-diagram"],"license":"MIT","category":"productivity","readme_excerpt":"What is markdown package The markdown package is a simple Markdown builder in Go. It assembles Markdown using method chaining, and does not use a template engine like html/template. The syntax follows GitHub Markdown. It covers the GitHub Markdown syntax: headings, lists, checkbox lists, tables, code blocks, blockquotes, horizontal rules, text formatting, links, images, details, footnotes, math expressions, and alerts. It also builds 24 mermaid diagram types, from sequence and flowchart to Gantt, C4 context, and Wardley map; each one has an example below. Two helpers go beyond Markdown syntax: status badges and an index for a directory full of markdown files. 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. Supported OS and go version - OS: Linux, macOS, Windows - Go: 1.23 or later Example Basic usage Output: go package main import \"fmt\" func main() { fmt.Println(\"Hello, World!\") } If you want to see how it looks in Markdown, please refer to the following link. - sample.md Generate Markdown using \"go generate ./...\" You can generate Markdown using go generate . Please define code to generate Markdown first. Then, run \"go generate ./...\" to generate Markdown. Code example: Run below command: Output: Alerts syntax The markdown package can create alerts. Alerts are useful for displaying important information in Markdown. This syntax is supported by GitHub. Code exampl","default_branch":null,"files":null,"tree":[],"storefront":"/r/nao1215","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/nao1215/markdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}