godoc2md

package module
v0.0.0-...-c545c5d Latest Latest
Warning

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

Go to latest
Published: Jun 28, 2019 License: BSD-3-Clause Imports: 17 Imported by: 0

README

godoc2md

import "github.com/WillAbides/godoc2md"

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

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

Constants

This section is empty.

Variables

This section is empty.

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

Directories

Path Synopsis
cmd
godoc2md
godoc2md converts godoc formatted package documentation into Markdown format.
godoc2md converts godoc formatted package documentation into Markdown format.
goreadme
goreadme creates a README.md from your godoc Usage goreadme [-check] [-out path/to/README.md] $PACKAGE
goreadme creates a README.md from your godoc Usage goreadme [-check] [-out path/to/README.md] $PACKAGE

Jump to

Keyboard shortcuts

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