d2svg

package

v0.7.1 Latest Latest Go to latest Published: Aug 19, 2025 License: MPL-2.0 Imports: 33 Imported by: 51

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/terrastruct/d2

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

d2svg implements an SVG renderer for d2 diagrams. The input is d2exporter's output

Index ¶

Constants
Variables
func EmbedFonts(buf *bytes.Buffer, diagramHash, source string, fontFamily *d2fonts.FontFamily, ...)
func Render(diagram *d2target.Diagram, opts *RenderOpts) ([]byte, error)
func RenderLegend(buf *bytes.Buffer, diagram *d2target.Diagram, diagramHash string, ...) error
func RenderMultiboard(diagram *d2target.Diagram, opts *RenderOpts) ([][]byte, error)
func RenderText(text string, x, height float64) string
func ThemeCSS(diagramHash string, themeID *int64, darkThemeID *int64, ...) (stylesheet string, err error)
type DiagramObject
type RenderOpts

Constants ¶

View Source

const (
	DEFAULT_PADDING = 100

	// Legend constants
	LEGEND_PADDING        = 20
	LEGEND_ITEM_SPACING   = 15
	LEGEND_ICON_SIZE      = 24
	LEGEND_FONT_SIZE      = 14
	LEGEND_CORNER_PADDING = 10
)

Variables ¶

View Source

var BaseStylesheet string

View Source

var DEFAULT_DARK_THEME *int64 = nil // no theme selected

View Source

var LinkIcon string

View Source

var MarkdownCSS string

View Source

var TooltipIcon string

Functions ¶

func EmbedFonts ¶ added in v0.3.0

func EmbedFonts(buf *bytes.Buffer, diagramHash, source string, fontFamily *d2fonts.FontFamily, monoFontFamily *d2fonts.FontFamily, corpus string)

func Render ¶

func Render(diagram *d2target.Diagram, opts *RenderOpts) ([]byte, error)

func RenderLegend ¶ added in v0.7.1

func RenderLegend(buf *bytes.Buffer, diagram *d2target.Diagram, diagramHash string, theme *d2themes.Theme) error

func RenderMultiboard ¶ added in v0.4.1

func RenderMultiboard(diagram *d2target.Diagram, opts *RenderOpts) ([][]byte, error)

func RenderText ¶ added in v0.1.4

func RenderText(text string, x, height float64) string

func ThemeCSS ¶ added in v0.3.0

func ThemeCSS(diagramHash string, themeID *int64, darkThemeID *int64, overrides, darkOverrides *d2target.ThemeOverrides) (stylesheet string, err error)

TODO include only colors that are being used to reduce size

Types ¶

type DiagramObject ¶ added in v0.1.0

type DiagramObject interface {
	GetID() string
	GetZIndex() int
}

type RenderOpts ¶ added in v0.1.3

type RenderOpts struct {
	Pad                *int64
	Sketch             *bool
	Center             *bool
	ThemeID            *int64
	DarkThemeID        *int64
	ThemeOverrides     *d2target.ThemeOverrides
	DarkThemeOverrides *d2target.ThemeOverrides
	Font               string
	// the svg will be scaled by this factor, if unset the svg will fit to screen
	Scale *float64

	// MasterID is passed when the diagram should use something other than its own hash for unique targeting
	// Currently, that's when multi-boards are collapsed
	MasterID    string
	NoXMLTag    *bool
	Salt        *string
	OmitVersion *bool
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
appendix

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL