dir

package

v1.5.0 Latest Latest Go to latest Published: Apr 25, 2023 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/91go/docs-training

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ExtractQuestion(file string) []string
func GenerateMD(qs []string) (rt string)
func GenerateMDTable(res [][]string)
func ReplaceUnorderedListWithTask(str string) string
type Dir
- func NewDir(name string) *Dir
type File
- func NewFile(name string) *File

Constants ¶

View Source

const (
	RegDetails       = `<details>[\s\S]*?</details>`
	RegUnorderedList = `(?m)^-\s(.*)`
	RegMD            = `*.md`
	MarkMD           = `.md`
	MarkDel          = "~~"
	MarkURL          = "http"
	MarkQuestionEN   = "?"
	MarkQuestionCN   = "？"
)

Variables ¶

This section is empty.

Functions ¶

func ExtractQuestion ¶

func ExtractQuestion(file string) []string

ExtractQuestion 从md中提取问题

func GenerateMD ¶

func GenerateMD(qs []string) (rt string)

GenerateMD 生成最终的md文档

func GenerateMDTable ¶

func GenerateMDTable(res [][]string)

GenerateMDTable 生成md表格

func ReplaceUnorderedListWithTask ¶

func ReplaceUnorderedListWithTask(str string) string

ReplaceUnorderedListWithTask 将无序列表替换为任务列表

Types ¶

type Dir ¶

type Dir struct {
	Name  string
	Files []File
}

func NewDir ¶

func NewDir(name string) *Dir

func (*Dir) AddFile ¶

func (d *Dir) AddFile(name string, questions []string)

func (*Dir) AddFiles ¶

func (d *Dir) AddFiles(files []File)

func (*Dir) Exclude ¶

func (d *Dir) Exclude(names []string) *Dir

Exclude 根据文件名，排除指定文件直接写文件名，不需要带路径。比如devops.md、mysql.md等，否则无法匹配。

func (*Dir) GetFile ¶

func (d *Dir) GetFile(name string) *File

func (*Dir) GetFileNum ¶

func (d *Dir) GetFileNum() int

func (*Dir) GetFiles ¶

func (d *Dir) GetFiles() []File

func (*Dir) GetQuestionNum ¶

func (d *Dir) GetQuestionNum() int

GetQuestionNum 获取所有题目数量

func (*Dir) GetQuestionNumByFile ¶

func (d *Dir) GetQuestionNumByFile(name string) int

GetQuestionNumByFile 获取指定文件的题目数量

func (*Dir) GetQuestionNumByFileReg ¶

func (d *Dir) GetQuestionNumByFileReg(reg string) int

GetQuestionNumByFileReg 获取指定文件的题目数量

func (*Dir) GetQuestionNumByFileRegEx ¶

func (d *Dir) GetQuestionNumByFileRegEx(reg string) int

func (*Dir) GetQuestionNumByFileRegExs ¶

func (d *Dir) GetQuestionNumByFileRegExs(regs []string) int

func (*Dir) GetQuestionNumByFiles ¶

func (d *Dir) GetQuestionNumByFiles(names []string) int

GetQuestionNumByFiles 获取指定文件的题目数量

func (*Dir) GetQuestions ¶

func (d *Dir) GetQuestions() (qs []string)

GetQuestions 获取所有Questions

func (*Dir) GetTableData ¶

func (d *Dir) GetTableData() (data [][]string)

GetTableData 组装tablewriter需要的数据

func (*Dir) Xz ¶

func (d *Dir) Xz() *Dir

type File ¶

type File struct {
	Name      string
	Questions []string
	Num       int
}

func NewFile ¶

func NewFile(name string) *File

func (*File) ConvertToMarkdown ¶

func (f *File) ConvertToMarkdown() (res string)

func (*File) GetQuestions ¶

func (f *File) GetQuestions() []string

func (*File) GetTableData ¶

func (f *File) GetTableData(dirname string, total int) (data [][]string)

GetTableData 组装tablewriter需要的数据

func (*File) Xz ¶

func (f *File) Xz() *File

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL