mcobra

README

mango-coral

coral adapter for mango.

Example

import (
	"fmt"

	mcoral "github.com/muesli/mango-coral"
	"github.com/muesli/roff"
	"github.com/muesli/coral"
)

var (
    rootCmd = &coral.Command{
        Use:   "mango",
        Short: "A man-page generator",
    }
)

func main() {
    manPage, err := mcoral.NewManPage(1, rootCmd)
    if err != nil {
        panic(err)
    }

    manPage = manPage.WithSection("Copyright", "(C) 2022 Christian Muehlhaeuser.\n"+
        "Released under MIT license.")

    fmt.Println(manPage.Build(roff.NewDocument()))
}

Documentation

Index

• func AddCommand(m *mango.ManPage, c *coral.Command) error
• func NewManPage(section uint, c *coral.Command) (*mango.ManPage, error)

Functions

func AddCommand

func AddCommand(m *mango.ManPage, c *coral.Command) error

AddCommand adds a coral.Command to a mango.ManPage.

func NewManPage

func NewManPage(section uint, c *coral.Command) (*mango.ManPage, error)

NewManPage creates a new mango.ManPage from a coral.Command.