godoc2md

README

godoc2md

import "github.com/WillAbides/godoc2md"

• Overview
• Index
• Subdirectories

Overview

Package godoc2md creates a markdown representation of a package's godoc.

This is forked from https://github.com/davecheney/godoc2md. The primary difference being that this version is a library that can be used by other packages.

Index

• func Godoc2md(args []string, out io.Writer, config *Config)
• type Config

Package files

commandline.go comment.go godoc2md.go template.go

func Godoc2md

func Godoc2md(args []string, out io.Writer, config *Config)

Godoc2md turns your godoc into markdown

type Config

type Config struct {
    AltPkgTemplate    string
    SrcLinkHashFormat string
    SrcLinkFormat     string
    Goroot            string
    TabWidth          int
    ShowTimestamps    bool
    ShowPlayground    bool
    ShowExamples      bool
    DeclLinks         bool
    Verbose           bool
}

Config contains config options for Godoc2md

Documentation

Overview

Package godoc2md creates a markdown representation of a package's godoc.

This is forked from https://github.com/davecheney/godoc2md. The primary difference being that this version is a library that can be used by other packages.

Index

• func Godoc2md(args []string, out io.Writer, config *Config)
• type Config

Functions

func Godoc2md

func Godoc2md(args []string, out io.Writer, config *Config)

Godoc2md turns your godoc into markdown

Types

type Config

type Config struct {
	AltPkgTemplate    string
	SrcLinkHashFormat string
	SrcLinkFormat     string
	Goroot            string
	TabWidth          int
	ShowTimestamps    bool
	ShowPlayground    bool
	ShowExamples      bool
	DeclLinks         bool
	Verbose           bool
}

Config contains config options for Godoc2md