Generate command line reference docs using cobra/doc

diggy · December 23, 2019, 3:28pm

Moved from GitHub dgraph/4463

Documentation

We can make use of cobra automatic command line reference generation to generate cmdline docs for dgraph.

spf13/cobra/blob/master/doc/md_docs.md

# Generating Markdown Docs For Your Own cobra.Command

Generating Markdown pages from a cobra command is incredibly easy. An example is as follows:

```go
package main

import (
	"log"

	"github.com/spf13/cobra"
	"github.com/spf13/cobra/doc"
)

func main() {
	cmd := &cobra.Command{
		Use:   "test",
		Short: "my test program",
	}
	err := doc.GenMarkdownTree(cmd, "/tmp")

This file has been truncated. show original

Topic		Replies	Views
Looking to create simple command-line document manager - dgraph the right tool? Dgraph	3	433	December 9, 2020
README.md for individual modules Users	5	961	July 6, 2016
Overview \| Documentation Documentation	0	445	December 13, 2020
Outputting GraphQL schemas to documentation (markdown file) GraphQL kind:question	1	878	April 12, 2021
Dgraph Directives reference (for other tools)? GraphQL help-wanted	3	1248	December 28, 2020

Generate command line reference docs using cobra/doc

Documentation

Related topics