d2compiler

Documentation

Overview

Package d2compiler implements a parser, compiler and autoformatter for the Terrastruct d2 diagramming language.

Index

• Variables
• func Compile(p string, r io.RuneReader, opts *CompileOptions) (*d2graph.Graph, *d2target.Config, error)
• type CompileOptions

Variables

var FullToShortLanguageAliases map[string]string

var ShortToFullLanguageAliases = map[string]string{
	"md":  "markdown",
	"tex": "latex",
	"js":  "javascript",
	"go":  "golang",
	"py":  "python",
	"rb":  "ruby",
	"ts":  "typescript",
}

TODO add more, e.g. C, bash

Functions

func Compile

func Compile(p string, r io.RuneReader, opts *CompileOptions) (*d2graph.Graph, *d2target.Config, error)

Types

type CompileOptions

type CompileOptions struct {
	UTF16 bool
	// FS is the file system used for resolving imports in the d2 text.
	// It should correspond to the root path.
	FS fs.FS
}