base

Documentation

Index

• Constants
• Variables
• func ExecPath() (string, error)
• func IsImageFile(data []byte) (string, bool)
• func IsMarkdownFile(name string) bool
• func IsReadmeFile(name string) bool
• func IsTextFile(data []byte) (string, bool)
• func Markdown(raw string) string
• func PostProcessMarkdown(rawHtml []byte, urlPrefix string, metas map[string]string) []byte
• func PreProcessMarkdown(rawHTML []byte, urlPrefix string) []byte
• func RenderIssueIndexPattern(rawBytes []byte, urlPrefix string, metas map[string]string) []byte
• func RenderMarkdown(rawBytes []byte, urlPrefix string, metas map[string]string) []byte
• func RenderMarkdownString(raw, urlPrefix string, metas map[string]string) string
• func RenderRawMarkdown(body []byte, urlPrefix string) []byte
• func RenderSha1CurrentPattern(rawBytes []byte, urlPrefix string) []byte
• func RenderSpecialLink(rawBytes []byte, urlPrefix string, metas map[string]string) []byte
• func ShortSha(sha1 string) string
• type CustomRender
  • func (options *CustomRender) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)
  • func (options *CustomRender) Link(out *bytes.Buffer, link []byte, title []byte, content []byte)
• type TplName

Constants

const DOC_URL = "https://github.com/gogits/go-gogs-client/wiki"

Variables

var GoGetMetas = make(map[string]bool)

var (
	MentionPattern = regexp.MustCompile(`(\s|^)@[0-9a-zA-Z_\.]+`)
)

var Sanitizer = bluemonday.UGCPolicy().AllowAttrs("class").Matching(regexp.MustCompile(`[\p{L}\p{N}\s\-_',:\[\]!\./\\\(\)&]*`)).OnElements("code")

Functions

func ExecPath

func ExecPath() (string, error)

ExecPath returns the executable path.

func IsImageFile

func IsImageFile(data []byte) (string, bool)

func IsMarkdownFile

func IsMarkdownFile(name string) bool

func IsReadmeFile

func IsReadmeFile(name string) bool

IsReadmeFile returns true if given file name suppose to be a README file.

func IsTextFile

func IsTextFile(data []byte) (string, bool)

func Markdown

func Markdown(raw string) string

func PostProcessMarkdown

func PostProcessMarkdown(rawHtml []byte, urlPrefix string, metas map[string]string) []byte

PostProcessMarkdown treats different types of HTML differently, and only renders special links for plain text blocks.

func PreProcessMarkdown

func PreProcessMarkdown(rawHTML []byte, urlPrefix string) []byte

PreProcessMarkdown renders full links of commits, issues and pulls to shorter version.

func RenderIssueIndexPattern

func RenderIssueIndexPattern(rawBytes []byte, urlPrefix string, metas map[string]string) []byte

func RenderMarkdown

func RenderMarkdown(rawBytes []byte, urlPrefix string, metas map[string]string) []byte

func RenderMarkdownString

func RenderMarkdownString(raw, urlPrefix string, metas map[string]string) string

func RenderRawMarkdown

func RenderRawMarkdown(body []byte, urlPrefix string) []byte

func RenderSha1CurrentPattern

func RenderSha1CurrentPattern(rawBytes []byte, urlPrefix string) []byte

func RenderSpecialLink

func RenderSpecialLink(rawBytes []byte, urlPrefix string, metas map[string]string) []byte

func ShortSha

func ShortSha(sha1 string) string

Types

type CustomRender

type CustomRender struct {
	blackfriday.Renderer
	// contains filtered or unexported fields
}

func (*CustomRender) Image

func (options *CustomRender) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)

func (*CustomRender) Link

func (options *CustomRender) Link(out *bytes.Buffer, link []byte, title []byte, content []byte)

type TplName

type TplName string