generate markdown documentation

13 files changed, 318 insertions, 0 deletions

diff --git a/doc/gen_markdown.go b/doc/gen_markdown.go
new file mode 100644
index 00000000..ee87d544
--- /dev/null
+++ b/doc/gen_markdown.go
@@ -0,0 +1,24 @@
+// +build ignore
+
+package main
+
+import (
+	"fmt"
+	"github.com/MichaelMure/git-bug/commands"
+	"github.com/spf13/cobra/doc"
+	"log"
+	"os"
+	"path"
+)
+
+func main() {
+	cwd, _ := os.Getwd()
+	filepath := path.Join(cwd, "doc", "md")
+
+	fmt.Println("Generating Markdown documentation ...")
+
+	err := doc.GenMarkdownTree(commands.RootCmd, filepath)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md
new file mode 100644
index 00000000..b6800a55
--- /dev/null
+++ b/doc/md/git-bug.md
@@ -0,0 +1,35 @@
+## git-bug
+
+A bugtracker embedded in Git
+
+### Synopsis
+
+git-bug is a bugtracker embedded in git.
+
+It use the same internal storage so it doesn't pollute your project. As you would do with commits and branches, you can push your bugs to the same git remote your are already using to collaborate with other peoples.
+
+```
+git-bug [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for git-bug
+```
+
+### SEE ALSO
+
+* [git-bug close](git-bug_close.md)	 - Mark the bug as closed
+* [git-bug commands](git-bug_commands.md)	 - Display available commands
+* [git-bug comment](git-bug_comment.md)	 - Add a new comment to a bug
+* [git-bug label](git-bug_label.md)	 - Manipulate bug's label
+* [git-bug ls](git-bug_ls.md)	 - Display a summary of all bugs
+* [git-bug new](git-bug_new.md)	 - Create a new bug
+* [git-bug open](git-bug_open.md)	 - Mark the bug as open
+* [git-bug pull](git-bug_pull.md)	 - Pull bugs update from a git remote
+* [git-bug push](git-bug_push.md)	 - Push bugs update to a git remote
+* [git-bug show](git-bug_show.md)	 - Display the details of a bug
+* [git-bug webui](git-bug_webui.md)	 - Launch the web UI
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_close.md b/doc/md/git-bug_close.md
new file mode 100644
index 00000000..89aa22c7
--- /dev/null
+++ b/doc/md/git-bug_close.md
@@ -0,0 +1,23 @@
+## git-bug close
+
+Mark the bug as closed
+
+### Synopsis
+
+Mark the bug as closed
+
+```
+git-bug close <id> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for close
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_commands.md b/doc/md/git-bug_commands.md
new file mode 100644
index 00000000..83a03b79
--- /dev/null
+++ b/doc/md/git-bug_commands.md
@@ -0,0 +1,24 @@
+## git-bug commands
+
+Display available commands
+
+### Synopsis
+
+Display available commands
+
+```
+git-bug commands [<option>...] [flags]
+```
+
+### Options
+
+```
+  -h, --help     help for commands
+  -p, --pretty   Output the command description as well as Markdown compatible comment
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_comment.md b/doc/md/git-bug_comment.md
new file mode 100644
index 00000000..73da1032
--- /dev/null
+++ b/doc/md/git-bug_comment.md
@@ -0,0 +1,25 @@
+## git-bug comment
+
+Add a new comment to a bug
+
+### Synopsis
+
+Add a new comment to a bug
+
+```
+git-bug comment <id> [<options>...] [flags]
+```
+
+### Options
+
+```
+  -F, --file string      Take the message from the given file. Use - to read the message from the standard input
+  -h, --help             help for comment
+  -m, --message string   Provide the new message from the command line
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_label.md b/doc/md/git-bug_label.md
new file mode 100644
index 00000000..8f4a112d
--- /dev/null
+++ b/doc/md/git-bug_label.md
@@ -0,0 +1,24 @@
+## git-bug label
+
+Manipulate bug's label
+
+### Synopsis
+
+Manipulate bug's label
+
+```
+git-bug label [<option>...] <id> [<label>...] [flags]
+```
+
+### Options
+
+```
+  -h, --help     help for label
+  -r, --remove   Remove a label
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_ls.md b/doc/md/git-bug_ls.md
new file mode 100644
index 00000000..7f08335a
--- /dev/null
+++ b/doc/md/git-bug_ls.md
@@ -0,0 +1,23 @@
+## git-bug ls
+
+Display a summary of all bugs
+
+### Synopsis
+
+Display a summary of all bugs
+
+```
+git-bug ls [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for ls
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_new.md b/doc/md/git-bug_new.md
new file mode 100644
index 00000000..6b8cdd75
--- /dev/null
+++ b/doc/md/git-bug_new.md
@@ -0,0 +1,25 @@
+## git-bug new
+
+Create a new bug
+
+### Synopsis
+
+Create a new bug
+
+```
+git-bug new <title> [<option>...] [flags]
+```
+
+### Options
+
+```
+  -F, --file string      Take the message from the given file. Use - to read the message from the standard input
+  -h, --help             help for new
+  -m, --message string   Provide a message to describe the issue
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_open.md b/doc/md/git-bug_open.md
new file mode 100644
index 00000000..c40eff51
--- /dev/null
+++ b/doc/md/git-bug_open.md
@@ -0,0 +1,23 @@
+## git-bug open
+
+Mark the bug as open
+
+### Synopsis
+
+Mark the bug as open
+
+```
+git-bug open <id> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for open
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_pull.md b/doc/md/git-bug_pull.md
new file mode 100644
index 00000000..b686d698
--- /dev/null
+++ b/doc/md/git-bug_pull.md
@@ -0,0 +1,23 @@
+## git-bug pull
+
+Pull bugs update from a git remote
+
+### Synopsis
+
+Pull bugs update from a git remote
+
+```
+git-bug pull [<remote>] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for pull
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_push.md b/doc/md/git-bug_push.md
new file mode 100644
index 00000000..355786a2
--- /dev/null
+++ b/doc/md/git-bug_push.md
@@ -0,0 +1,23 @@
+## git-bug push
+
+Push bugs update to a git remote
+
+### Synopsis
+
+Push bugs update to a git remote
+
+```
+git-bug push [<remote>] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for push
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_show.md b/doc/md/git-bug_show.md
new file mode 100644
index 00000000..3289ba2a
--- /dev/null
+++ b/doc/md/git-bug_show.md
@@ -0,0 +1,23 @@
+## git-bug show
+
+Display the details of a bug
+
+### Synopsis
+
+Display the details of a bug
+
+```
+git-bug show <id> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for show
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018
diff --git a/doc/md/git-bug_webui.md b/doc/md/git-bug_webui.md
new file mode 100644
index 00000000..4ef34e7b
--- /dev/null
+++ b/doc/md/git-bug_webui.md
@@ -0,0 +1,23 @@
+## git-bug webui
+
+Launch the web UI
+
+### Synopsis
+
+Launch the web UI
+
+```
+git-bug webui [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for webui
+```
+
+### SEE ALSO
+
+* [git-bug](git-bug.md)	 - A bugtracker embedded in Git
+
+###### Auto generated by spf13/cobra on 20-Jul-2018