mirror of
				https://gitea.com/gitea/tea.git
				synced 2025-10-31 01:05:26 +01:00 
			
		
		
		
	Initial CLI docs (#565)
As title, then we could potentially start ingesting these in the docs repo as they are expanded. Reviewed-on: https://gitea.com/gitea/tea/pulls/565 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: jolheiser <john.olheiser@gmail.com> Co-committed-by: jolheiser <john.olheiser@gmail.com>
This commit is contained in:
		 jolheiser
					jolheiser
				
			
				
					committed by
					
						 techknowlogick
						techknowlogick
					
				
			
			
				
	
			
			
			 techknowlogick
						techknowlogick
					
				
			
						parent
						
							e4e8eb07d2
						
					
				
				
					commit
					0869c15a6c
				
			
							
								
								
									
										56
									
								
								cmd/docs.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										56
									
								
								cmd/docs.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,56 @@ | ||||
| // Copyright 2023 The Gitea Authors. All rights reserved. | ||||
| // Use of this source code is governed by a MIT-style | ||||
| // license that can be found in the LICENSE file. | ||||
|  | ||||
| package cmd | ||||
|  | ||||
| import ( | ||||
| 	"fmt" | ||||
| 	"os" | ||||
| 	"path/filepath" | ||||
|  | ||||
| 	"github.com/urfave/cli/v2" | ||||
| ) | ||||
|  | ||||
| // CmdDocs generates markdown for tea | ||||
| var CmdDocs = cli.Command{ | ||||
| 	Name:        "docs", | ||||
| 	Hidden:      true, | ||||
| 	Description: "Generate CLI docs", | ||||
| 	Action:      runDocs, | ||||
| 	Flags: []cli.Flag{ | ||||
| 		&cli.StringFlag{ | ||||
| 			Name:    "out", | ||||
| 			Usage:   "Path to output docs to, otherwise prints to stdout", | ||||
| 			Aliases: []string{"o"}, | ||||
| 		}, | ||||
| 	}, | ||||
| } | ||||
|  | ||||
| func runDocs(ctx *cli.Context) error { | ||||
| 	md, err := ctx.App.ToMarkdown() | ||||
| 	if err != nil { | ||||
| 		return err | ||||
| 	} | ||||
|  | ||||
| 	outPath := ctx.String("out") | ||||
| 	if outPath == "" { | ||||
| 		fmt.Print(md) | ||||
| 		return nil | ||||
| 	} | ||||
|  | ||||
| 	if err := os.MkdirAll(filepath.Dir(outPath), os.ModePerm); err != nil { | ||||
| 		return err | ||||
| 	} | ||||
|  | ||||
| 	fi, err := os.Create(outPath) | ||||
| 	if err != nil { | ||||
| 		return err | ||||
| 	} | ||||
| 	defer fi.Close() | ||||
| 	if _, err := fi.WriteString(md); err != nil { | ||||
| 		return err | ||||
| 	} | ||||
|  | ||||
| 	return nil | ||||
| } | ||||
		Reference in New Issue
	
	Block a user