pkg

README

github.com/jylitalo/go2md/pkg

Overview

Package pkg provides the backend functionality for golang to markdown transformation.

Imports: 16

Index

• Variables
• func Output(out io.Writer, directory, filename string) (io.Writer, func() error, error)
• func Run(out io.Writer, directory, version string) error
• func RunDirTree(out io.Writer, directory, output, version string) error

Examples

This section is empty.

Constants

This section is empty.

Variables

var Markdown string // value from template.md file

Markdown is golang template for go2md output

Functions

func Output

func Output(out io.Writer, directory, filename string) (io.Writer, func() error, error)

Output creates output file if needed and returns writer to it

func Run

func Run(out io.Writer, directory, version string) error

Run reads all ".go" files (excluding "_test.go") and writes markdown document out of it.

func RunDirTree

func RunDirTree(out io.Writer, directory, output, version string) error

RunDirTree checks given directory and its subdirectories for golang

--

Generated by github.com/jylitalo/go2md v0.4.1

Documentation

Overview

Package pkg provides the backend functionality for golang to markdown transformation.

Index

• Variables
• func Output(out io.Writer, directory, filename string) (io.Writer, func() error, error)
• func Run(out io.Writer, directory, version string) error
• func RunDirTree(out io.Writer, directory, output, version string) error

Variables

var Markdown string // value from template.md file

Markdown is golang template for go2md output

Functions

func Output

func Output(out io.Writer, directory, filename string) (io.Writer, func() error, error)

Output creates output file if needed and returns writer to it

func Run

func Run(out io.Writer, directory, version string) error

Run reads all "*.go" files (excluding "*_test.go") and writes markdown document out of it.

func RunDirTree

func RunDirTree(out io.Writer, directory, output, version string) error

RunDirTree checks given directory and its subdirectories for golang