commands

Documentation

Overview

Package commands provides functions for CLI commands

Package commands provides functions for CLI commands

Index

• func GetDirHref(filehref, dirname string) string
• func GetHelp()
• func GetIgnoreDirs(toIgnore string) []string
• func GetMarkdown(url, extension, toIgnore string, cfg MarkdownConfig)
• func IsContains(elements []string, some string) bool
• func ParseHrefAttr(href, extension string) (bool, bool, string)
• type MarkdownConfig

Functions

func GetDirHref

func GetDirHref(filehref, dirname string) string

GetDirHref gets href to file and returns link to dir where this file placed.

func GetHelp

func GetHelp()

GetHelp returns help for help CLI command.

func GetIgnoreDirs

func GetIgnoreDirs(toIgnore string) []string

GetIgnoreDirs returns dirs which should be ignored.

func GetMarkdown

func GetMarkdown(url, extension, toIgnore string, cfg MarkdownConfig)

GetMarkdown is CLI command which prints into file generated markdown for this repository.

func IsContains

func IsContains(elements []string, some string) bool

IsContains checks whether an item is in a list or in a list item.

func ParseHrefAttr

func ParseHrefAttr(href, extension string) (bool, bool, string)

ParseHrefAttr get href and file extension and returns is this item mdFile or mdDir and dirname.

Types

type MarkdownConfig

type MarkdownConfig struct {
	Files string // Files prefix in markdown
	Dirs  string // Directories prefix in markdown
}

MarkdownConfig is type which defines markdown output struct.