yuml2svg

Documentation

Overview

Package yuml2svg generates yuml files using the yuml2svg Typescript package.

Requires yarn to install yuml2svg globally. For more infos: https://github.com/aduh95/yuml2svg#readme For vscode snippets: https://github.com/aduh95/yuml2svg/blob/master/test/snippets.json

Index

• func GenerateYuml(settings Settings, yumlPath string, toSvgPath string) (err error)
• func GenerateYumlInplace(settings Settings, yumlPath string) (err error)
• func GenerateYumls(settings Settings, root string) (err error)
• func Install(r dash.Runner) (err error)
• type Settings

Functions

func GenerateYuml

func GenerateYuml(settings Settings, yumlPath string, toSvgPath string) (err error)

GenerateYuml generates an svg from a given yuml file.

func GenerateYumlInplace

func GenerateYumlInplace(settings Settings, yumlPath string) (err error)

GenerateYumlInplace generates an svg from the given yuml. The name is the source name with the extension exchanged with svg.

func GenerateYumls

func GenerateYumls(settings Settings, root string) (err error)

GenerateYumls walks the directory path and generates svgs from yuml files.

The svg files are named the same as the yuml files with the suffix replaced.

func Install

func Install(r dash.Runner) (err error)

Install yuml2svg with yarn.

Types

type Settings

type Settings struct {
	// If Dark is true then the svg is rendered for dark mode, edges are white.
	// If Dark is false then the svg is rendered for light mode, edges are black.
	Dark bool
	// contains filtered or unexported fields
}

Settings contain options used during yuml->svg conversion.