markdown

package

v0.7.0 Latest Latest Go to latest Published: Oct 24, 2025 License: MIT Imports: 8 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type DiffResult struct {
	PrettyDiff string
	HasDiff    bool
}

type Doc struct {
	// contains filtered or unexported fields
}

func NewDoc(name string) (*Doc, error)

func NewDocOrCreate(name string) (*Doc, error)

NewDocOrCreate creates a new Doc from an existing file, or creates a new file with template content if it doesn't exist

func NewEmptyDoc(name string) *Doc

NewEmptyDoc creates an empty Doc with just the name (used for comparing against non-existent files)

func (d *Doc) Copy() Doc

func (d *Doc) Diff(doc *Doc) DiffResult

func (d *Doc) Equals(doc Doc) bool

func (d *Doc) GetName() string

func (d *Doc) IsInsideCodeBlock(lineIndex int) bool

IsInsideCodeBlock checks if the line at the given index is inside a markdown code block

func (d *Doc) ToString() string

func (d *Doc) Update(a *action.Action) error

func (d *Doc) UpdateUsage(a *action.Action) error

func (d *Doc) WriteToFile() error