renderer

package

v0.4.0 Latest Latest Go to latest Published: May 7, 2026 License: MIT Imports: 10 Imported by: 0

Details

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

Repository

github.com/glincker/stacklit

Links

Open Source Insights

Documentation ¶

Index ¶

func RenderMarkdown(idx *schema.Index) string
func WriteHTML(idx *schema.Index, path string) error
func WriteJSON(idx *schema.Index, path string) error
func WriteMarkdown(idx *schema.Index, path string) error
func WriteMermaid(idx *schema.Index, path string) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RenderMarkdown ¶ added in v0.4.0

func RenderMarkdown(idx *schema.Index) string

RenderMarkdown returns a human-readable markdown overview of idx, designed for pasting into PR descriptions, GitHub issues, or chat. It's deterministic: modules and dependencies are sorted, so the output diffs cleanly between runs and between machines.

func WriteHTML ¶

func WriteHTML(idx *schema.Index, path string) error

WriteHTML renders idx as a self-contained HTML file with an interactive force-directed dependency graph and writes it to path.

func WriteJSON ¶

func WriteJSON(idx *schema.Index, path string) error

WriteJSON populates metadata fields on idx and writes it as indented JSON to path.

func WriteMarkdown ¶ added in v0.4.0

func WriteMarkdown(idx *schema.Index, path string) error

WriteMarkdown writes the rendered markdown to path. If the file already matches the new content byte-for-byte, the file is left untouched so commit hooks don't see spurious changes.

func WriteMermaid ¶

func WriteMermaid(idx *schema.Index, path string) error

WriteMermaid generates a Mermaid graph LR diagram from idx and writes it to path.

Types ¶

This section is empty.

Source Files ¶

View all Source files

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