process

Documentation

Index

• func Pre(content string) string
• type Block
  • func Parse(markdown string) []Block
  • func (b *Block) Execute()
  • func (b Block) String() string

Functions

func Pre

func Pre(content string) string

Pre processes the markdown content by executing the commands necessary and returns the new processed content

Types

type Block

type Block struct {
	Command string
	Input   string
	Output  string
	Raw     string
}

Block represents a pre-processable block which looks like the following: It is delimited by ~~~ and contains a command to be run along with the input to be passed, the entire block should be replaced with its command output

~~~sd block process block ~~~

func Parse

func Parse(markdown string) []Block

Parse takes some markdown and returns blocks to be pre-processed

func (*Block) Execute

func (b *Block) Execute()

Execute takes performs the execution of the block's command by passing in the block's input as stdin and sets the block output

func (Block) String

func (b Block) String() string

String implements the Stringer interface.