-
Notifications
You must be signed in to change notification settings - Fork 23
/
gendocs.go
86 lines (73 loc) · 2.26 KB
/
gendocs.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
// Copyright © 2020 Lucas dos Santos Abreu <lucas.s.abreu@gmail.com>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd
import (
"fmt"
"os"
"path"
"path/filepath"
"strings"
"time"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
)
const gendocFrontmatterTemplate = `---
date: %s
title: "%s"
slug: %s
url: %s
weight: 40
---
`
// gendocsCmd represents the gendocs command
var gendocsCmd = &cobra.Command{
Use: "gendocs <output-dir>",
Short: "Generate Markdown documentation for the clockify-cli.",
Long: `Generate Markdown documentation for the clockify-cli.
This command is, mostly, used to create up-to-date documentation
of the command-line interface.
It creates one Markdown file per command with front matter suitable
for rendering in Hugo.`,
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
docdir := "docs/content/en/commands"
if len(args) >= 1 {
docdir = args[0]
}
if err := os.MkdirAll(docdir, os.ModePerm); err != nil {
return err
}
now := time.Now().Format("2006-01-02")
prepender := func(filename string) string {
name := filepath.Base(filename)
base := strings.TrimSuffix(name, path.Ext(name))
url := "/en/commands/" + strings.ToLower(base) + "/"
return fmt.Sprintf(gendocFrontmatterTemplate, now, strings.Replace(base, "_", " ", -1), base, url)
}
linkHandler := func(name string) string {
base := strings.TrimSuffix(name, path.Ext(name))
return "/en/commands/" + strings.ToLower(base) + "/"
}
fmt.Println("Generating Hugo command-line documentation in", docdir, "...")
err := doc.GenMarkdownTreeCustom(cmd.Root(), docdir, prepender, linkHandler)
if err != nil {
return err
}
fmt.Println("Done.")
return nil
},
}
func init() {
rootCmd.AddCommand(gendocsCmd)
}