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

render

package
v0.57.0 Latest Latest
Warning

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

Go to latest
Published: Oct 30, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package render provides the render.markdown stream operator, which reformats FileContent into a single Markdown document. The editor option selects the framing (markdown, zed, claude, fold).

Typical use:

fs.walk -> fs.filter:ext="go" -> fs.read -> render.markdown:editor="zed" -> out.file:path="context.md"

Index

Constants

View Source
const ID = "render"

Variables

This section is empty.

Functions

func Bundle

func Bundle(_ map[string]string) compiler.Bundle

func Library

func Library() action.Library

func Markdown

Markdown concatenates every file into a single Markdown stream. Each file's Content is replaced with its formatted representation; FileMeta is preserved so downstream stages can still inspect paths.

func MarkdownOperator

func MarkdownOperator() action.NamedOperator

Types

type Config

type Config struct {
	// Editor selects the framing: "markdown" (default), "zed", "claude",
	// or "fold" (details/summary).
	Editor   string `json:"editor"    cli:"editor,e"`
	NoHeader bool   `json:"no_header" cli:"no_header"`
	Prompt   string `json:"prompt"    cli:"prompt"`
}

Config controls render.markdown.

Jump to

Keyboard shortcuts

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