package diagram

Import Path
	github.com/AlexanderGrooff/mermaid-ascii/pkg/diagram (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	    config.go
	    interface.go
	    utils.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Config (struct)
		Config holds configuration for diagram rendering.
		This replaces global variables and makes the rendering functions testable and thread-safe.

		Fields (total 11)
			BoxBorderPadding int
				BoxBorderPadding is the padding between text and border in graph nodes

			GraphDirection string
				GraphDirection is the direction of graph layout ("LR" or "TD")

			PaddingBetweenX int
				PaddingBetweenX is the horizontal space between nodes in graphs

			PaddingBetweenY int
				PaddingBetweenY is the vertical space between nodes in graphs

			SequenceMessageSpacing int
				SequenceMessageSpacing is the vertical space between messages (lifeline segments)

			SequenceParticipantSpacing int
				SequenceParticipantSpacing is the horizontal space between participants

			SequenceSelfMessageWidth int
				SequenceSelfMessageWidth is the width of self-message loops

			ShowCoords bool
				ShowCoords displays coordinate debugging information (for development)

			StyleType string
				StyleType determines output format for graph diagrams ("cli" or "html")
				This controls whether graphs use colored output (html) or plain text (cli)

			UseAscii bool
				UseAscii determines whether to use ASCII characters (true) or Unicode box-drawing characters (false)

			Verbose bool
				Verbose enables detailed logging

		Methods (only one)
			(*Config) Validate() error
				Validate checks if the configuration values are valid.
				Returns an error if any values are invalid or would cause rendering issues.

		As Outputs Of (at least 5)
			func DefaultConfig() *Config
			func NewCLIConfig(useAscii, showCoords, verbose bool, boxBorderPadding, paddingX, paddingY int, graphDirection string) (*Config, error)
			func NewConfig(useAscii bool, graphDirection, styleType string) (*Config, error)
			func NewTestConfig(useAscii bool, styleType string) *Config
			func NewWebConfig(useAscii bool, boxBorderPadding, paddingX, paddingY int) (*Config, error)
		As Inputs Of (at least 2)
			func Diagram.Render(config *Config) (string, error)
			func github.com/AlexanderGrooff/mermaid-ascii/pkg/sequence.Render(sd *sequence.SequenceDiagram, config *Config) (string, error)

	 type ConfigError (struct)
		ConfigError represents an invalid configuration value.

		Fields (total 3)
			Field string
			Message string
			Value interface{}
		Methods (only one)
			(*ConfigError) Error() string
		Implements (at least one exported)
			*ConfigError : error

	 type Diagram (interface)
		Diagram is the interface for all diagram types (graph, sequence, etc.)

		Methods (total 3)
			( Diagram) Parse(input string) error
			( Diagram) Render(config *Config) (string, error)
			( Diagram) Type() string


Package-Level Functions (total 7)

	 func DefaultConfig() *Config
		DefaultConfig returns a Config with sensible defaults.
		The returned config is guaranteed to pass validation.

	 func NewCLIConfig(useAscii, showCoords, verbose bool, boxBorderPadding, paddingX, paddingY int, graphDirection string) (*Config, error)
	 func NewConfig(useAscii bool, graphDirection, styleType string) (*Config, error)
		NewConfig creates a new Config with the provided values and validates them.
		Returns an error if any values are invalid.
		For default values, use DefaultConfig() instead.

	 func NewTestConfig(useAscii bool, styleType string) *Config
		NewTestConfig creates a Config for testing with sensible defaults.
		The styleType parameter determines output format ("cli" or "html").

	 func NewWebConfig(useAscii bool, boxBorderPadding, paddingX, paddingY int) (*Config, error)
	 func RemoveComments(lines []string) []string
		removeComments removes Mermaid comment lines from input.
		This function is shared between graph and sequence diagram parsers.
		It handles both full-line comments (%% at start) and inline comments (%% after content).

	 func SplitLines(input string) []string
		SplitLines splits input on both actual newlines and escaped newlines (for curl compatibility).

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.