example

command
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Jan 19, 2023 License: Apache-2.0, MIT Imports: 1 Imported by: 0

README

Example

This directory directory contains a simple example application created with the cobra command.

cobra init
conra add hello
cobra add goodbye

I then added the code in docutil to create a little utility that generates the documentation for the example application. This utility uses the CreateDocGenCmdLineTool and related functions to a create a command-line tool for generating does just for this example application.

To generate the sample documentation do:

cd example/docutil
go build
./docutil generate-troff

Or run ./docutil --help to see additional options.

Documentation

Overview

Package main creates example documentation

Directories

Path Synopsis
Package cmd is an example cobra application used to demonstrate the output of cobraman
Package cmd is an example cobra application used to demonstrate the output of cobraman
Package main generates the documentation for the example application
Package main generates the documentation for the example application

Jump to

Keyboard shortcuts

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