utils

Documentation

Index

• func DiscoverFiles(rootDir string) (error, []string)
• func GenerateUrls(router *gin.Engine, rootDir string, files []string) error
• func ProcessFile(path string) (error, []byte)

Functions

func DiscoverFiles

func DiscoverFiles(rootDir string) (error, []string)

DiscoverFiles discovers all markdown files which are within a directory and its subdirectories recursively, if successfull, it returns err!=nil and a list of paths relative to rootDir

func GenerateUrls

func GenerateUrls(router *gin.Engine, rootDir string, files []string) error

GenerateUrls takes the router and generates appropriate urls for the found markdown files if err!=nil it returns the encountered error. The markdown files are assumed to be safe code.

func ProcessFile

func ProcessFile(path string) (error, []byte)

ProcessFile reads the file from the path and converts the markdown content into html, if successfull it returns error=nil and the markdown html as an array of bytes