github.com/phsym/gomarkdoc@v0.5.4/cmd/gomarkdoc/README.md (about) 1 <!-- Code generated by gomarkdoc. DO NOT EDIT --> 2 3 # gomarkdoc 4 5 ```go 6 import "github.com/phsym/gomarkdoc/cmd/gomarkdoc" 7 ``` 8 9 Package gomarkdoc provides a command line interface for writing golang documentation in markdown format. 10 11 See https://github.com/phsym/gomarkdoc for full documentation of this tool. 12 13 ## Index 14 15 - [type PackageSpec](<#type-packagespec>) 16 17 18 ## type [PackageSpec](<https://github.com/phsym/gomarkdoc/blob/master/cmd/gomarkdoc/command.go#L30-L44>) 19 20 PackageSpec defines the data available to the \-\-output option's template. Information is recomputed for each package generated. 21 22 ```go 23 type PackageSpec struct { 24 // Dir holds the local path where the package is located. If the package is 25 // a remote package, this will always be ".". 26 Dir string 27 28 // ImportPath holds a representation of the package that should be unique 29 // for most purposes. If a package is on the filesystem, this is equivalent 30 // to the value of Dir. For remote packages, this holds the string used to 31 // import that package in code (e.g. "encoding/json"). 32 ImportPath string 33 // contains filtered or unexported fields 34 } 35 ``` 36 37 38 39 Generated by [gomarkdoc](<https://github.com/phsym/gomarkdoc>)