doc

package

v0.28.0 Latest Latest Go to latest Published: Sep 3, 2025 License: MIT Imports: 8 Imported by: 0

Details

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

Repository

github.com/Azure/alzlib

Links

Open Source Insights

Documentation ¶

Overview ¶

Package doc provides functions to generate documentation for alzlib libraries in Markdown format.

Index ¶

Variables
func AlzlibReadmeMd(ctx context.Context, w io.Writer, libs ...alzlib.LibraryReference) error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrReadmeGenerationFailed is returned when the README generation fails.
	ErrReadmeGenerationFailed = fmt.Errorf("failed to generate README")
)

Functions ¶

func AlzlibReadmeMd ¶

func AlzlibReadmeMd(ctx context.Context, w io.Writer, libs ...alzlib.LibraryReference) error

AlzlibReadmeMd generates a Markdown formatted README for the given alzlib libraries.

Types ¶

This section is empty.

Source Files ¶

View all Source files

doc.go

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