docgen

package module
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Jun 10, 2023 License: MIT Imports: 9 Imported by: 2

README

UrFaveCli DocGen

Go Report Card shields shields shields

Library to generate documents for urfave-cli.

Introduction

This library would be helpful when generating Markdown documents for the command-line interfaces built using https://cli.urfave.org.

Installation

Get latest version of urfavecli-docgen using go get command. Example:

go get github.com/nikhilsbhat/urfavecli-docgen@latest

Get specific version of the same. Example:

go get github.com/nikhilsbhat/urfavecli-docgen@v0.0.2

Usage

package main

import (
	"fmt"
	"log"

	"github.com/nikhilsbhat/urfavecli-docgen"
)

func main() {
	appCli := cli.App{}

	if err := docgen.GenerateDocs(&appCli); err != nil {
		log.Fatalln(err)
	}
}

More examples can be found here.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateDocs

func GenerateDocs(app *cli.App, file string) error

GenerateDocs generates markdown documentation for the commands in app.

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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