Help us shape the future of Go! Take the 2026 Go Developer Survey

markdown

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 17, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	HeadingPrefix               = markdown.HeadingPrefix
	WriteMarkdownHeader         = markdown.WriteHeader
	WriteMarkdown               = markdown.WriteResult
	WriteMarkdownSummary        = markdown.WriteSummary
	WriteRepoMarkdown           = markdown.WriteRepo
	WriteListMarkdown           = markdown.WriteList
	WriteWorktreeList           = markdown.WriteWorktreeList
	ParseResultFiles            = markdown.ParseResultFiles
	WriteLsFilesMarkdown        = markdown.WriteLsFiles
	WriteLsFilesMarkdownSummary = markdown.WriteLsFilesSummary
)

Forwarding aliases to internal/markdown.

Functions

This section is empty.

Types

type LsFilesMarkdownExecutor

type LsFilesMarkdownExecutor struct {
	Title       string
	MaxProcs    int
	FailFast    bool
	Timeout     time.Duration
	HeaderLevel int
	Out         io.Writer
}

LsFilesMarkdownExecutor runs Tasks concurrently (bounded by MaxProcs), writes each repository's file list formatted as Markdown to Out, and writes an aggregate summary at the end.

func (*LsFilesMarkdownExecutor) Run

func (e *LsFilesMarkdownExecutor) Run(ctx context.Context, tasks []common.Task) error

Run executes all tasks and writes Markdown output for ls-files.

type MarkdownExecutor

type MarkdownExecutor struct {
	Title       string
	MaxProcs    int
	FailFast    bool
	Timeout     time.Duration
	HeaderLevel int
	Out         io.Writer
}

MarkdownExecutor runs Tasks concurrently (bounded by MaxProcs), captures each task's stdout and stderr, writes each result formatted as Markdown to Out, and writes an aggregate summary at the end.

func (*MarkdownExecutor) Run

func (e *MarkdownExecutor) Run(ctx context.Context, tasks []common.Task) error

Run executes all tasks and blocks until they complete.

Jump to

Keyboard shortcuts

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