31c7181297
- Fix name of man pages for all but the toplevel command - Set title of all man pages to "GitHub CLI manual" - Include gh version information in man pages - Clean up rendering of flags section - List subcommands for every command
86 lines
1.7 KiB
Go
86 lines
1.7 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/cli/cli/v2/internal/docs"
|
|
"github.com/cli/cli/v2/pkg/cmd/root"
|
|
"github.com/cli/cli/v2/pkg/cmdutil"
|
|
"github.com/cli/cli/v2/pkg/iostreams"
|
|
"github.com/spf13/pflag"
|
|
)
|
|
|
|
func main() {
|
|
if err := run(os.Args); err != nil {
|
|
fmt.Fprintln(os.Stderr, err)
|
|
os.Exit(1)
|
|
}
|
|
}
|
|
|
|
func run(args []string) error {
|
|
flags := pflag.NewFlagSet("", pflag.ContinueOnError)
|
|
manPage := flags.BoolP("man-page", "", false, "Generate manual pages")
|
|
website := flags.BoolP("website", "", false, "Generate website pages")
|
|
dir := flags.StringP("doc-path", "", "", "Path directory where you want generate doc files")
|
|
help := flags.BoolP("help", "h", false, "Help about any command")
|
|
|
|
if err := flags.Parse(args); err != nil {
|
|
return err
|
|
}
|
|
|
|
if *help {
|
|
fmt.Fprintf(os.Stderr, "Usage of %s:\n\n%s", filepath.Base(args[0]), flags.FlagUsages())
|
|
return nil
|
|
}
|
|
|
|
if *dir == "" {
|
|
return fmt.Errorf("error: --doc-path not set")
|
|
}
|
|
|
|
io, _, _, _ := iostreams.Test()
|
|
rootCmd := root.NewCmdRoot(&cmdutil.Factory{
|
|
IOStreams: io,
|
|
Browser: &browser{},
|
|
}, "", "")
|
|
rootCmd.InitDefaultHelpCmd()
|
|
|
|
if err := os.MkdirAll(*dir, 0755); err != nil {
|
|
return err
|
|
}
|
|
|
|
if *website {
|
|
if err := docs.GenMarkdownTreeCustom(rootCmd, *dir, filePrepender, linkHandler); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if *manPage {
|
|
if err := docs.GenManTree(rootCmd, *dir); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func filePrepender(filename string) string {
|
|
return `---
|
|
layout: manual
|
|
permalink: /:path/:basename
|
|
---
|
|
|
|
`
|
|
}
|
|
|
|
func linkHandler(name string) string {
|
|
return fmt.Sprintf("./%s", strings.TrimSuffix(name, ".md"))
|
|
}
|
|
|
|
type browser struct{}
|
|
|
|
func (b *browser) Browse(url string) error {
|
|
return nil
|
|
}
|