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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateYuml ¶ added in v0.1.5
GenerateYuml generates an svg from a given yuml file.
func GenerateYumlInplace ¶ added in v0.1.20
GenerateYumlInplace generates an svg from the given yuml. The name is the source name with the extension exchanged with svg.
func GenerateYumls ¶
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.
Types ¶
type Settings ¶ added in v0.1.5
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.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.