github.com/rmarku/gomarkdoc@v0.0.0-20230517164305-78688ebe4325/cmd/gomarkdoc/README.md (about)

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