Documentation
¶
Index ¶
- Constants
- func FindAllMentions(content string) []string
- func Init()
- func IsLink(link []byte) bool
- func IsMarkupFile(name, markup string) bool
- func IsReadmeFile(name string) bool
- func IsSameDomain(s string) bool
- func NewSanitizer()
- func PostProcess(rawHTML []byte, urlPrefix string, metas map[string]string, isWikiMarkdown bool) ([]byte, error)
- func RegisterParser(parser Parser)
- func Render(filename string, rawBytes []byte, urlPrefix string, metas map[string]string) []byte
- func RenderByType(tp string, rawBytes []byte, urlPrefix string, metas map[string]string) []byte
- func RenderCommitMessage(rawHTML []byte, urlPrefix, defaultLink string, metas map[string]string) ([]byte, error)
- func RenderString(filename string, raw, urlPrefix string, metas map[string]string) string
- func RenderWiki(filename string, rawBytes []byte, urlPrefix string, metas map[string]string) string
- func Sanitize(s string) string
- func SanitizeBytes(b []byte) []byte
- func Type(filename string) string
- type Parser
- type Sanitizer
Constants ¶
const (
IssueNameStyleNumeric = "numeric"
IssueNameStyleAlphanumeric = "alphanumeric"
)
Issue name styles
Variables ¶
This section is empty.
Functions ¶
func FindAllMentions ¶ added in v1.3.0
func FindAllMentions(content string) []string
FindAllMentions matches mention patterns in given content and returns a list of found user names without @ prefix.
func IsLink ¶ added in v1.3.0
func IsLink(link []byte) bool
IsLink reports whether link fits valid format.
func IsMarkupFile ¶ added in v1.3.0
func IsMarkupFile(name, markup string) bool
IsMarkupFile reports whether file is a markup type file
func IsReadmeFile ¶
func IsReadmeFile(name string) bool
IsReadmeFile reports whether name looks like a README file based on its name.
func IsSameDomain ¶ added in v1.3.0
func IsSameDomain(s string) bool
IsSameDomain checks if given url string has the same hostname as current Gitea instance
func NewSanitizer ¶ added in v1.3.0
func NewSanitizer()
NewSanitizer initializes sanitizer with allowed attributes based on settings. Multiple calls to this function will only create one instance of Sanitizer during entire application lifecycle.
func PostProcess ¶ added in v1.3.0
func PostProcess(
rawHTML []byte,
urlPrefix string,
metas map[string]string,
isWikiMarkdown bool,
) ([]byte, error)
PostProcess does the final required transformations to the passed raw HTML data, and ensures its validity. Transformations include: replacing links and emails with HTML links, parsing shortlinks in the format of [[Link]], like MediaWiki, linking issues in the format #ID, and mentions in the format @user, and others.
func RegisterParser ¶
func RegisterParser(parser Parser)
RegisterParser registers a new markup file parser
func Render ¶
func Render(filename string, rawBytes []byte, urlPrefix string, metas map[string]string) []byte
Render renders markup file to HTML with all specific handling stuff.
func RenderByType ¶ added in v1.3.0
func RenderByType(tp string, rawBytes []byte, urlPrefix string, metas map[string]string) []byte
RenderByType renders markup to HTML with special links and returns string type.
func RenderCommitMessage ¶ added in v1.5.0
func RenderCommitMessage(
rawHTML []byte,
urlPrefix, defaultLink string,
metas map[string]string,
) ([]byte, error)
RenderCommitMessage will use the same logic as PostProcess, but will disable the shortLinkProcessor and will add a defaultLinkProcessor if defaultLink is set, which changes every text node into a link to the passed default link.
func RenderString ¶
func RenderString(filename string, raw, urlPrefix string, metas map[string]string) string
RenderString renders Markdown to HTML with special links and returns string type.
func RenderWiki ¶
func RenderWiki(filename string, rawBytes []byte, urlPrefix string, metas map[string]string) string
RenderWiki renders markdown wiki page to HTML and return HTML string
func Sanitize ¶ added in v1.3.0
func Sanitize(s string) string
Sanitize takes a string that contains a HTML fragment or document and applies policy whitelist.
func SanitizeBytes ¶ added in v1.3.0
func SanitizeBytes(b []byte) []byte
SanitizeBytes takes a []byte slice that contains a HTML fragment or document and applies policy whitelist.
Types ¶
type Parser ¶
type Parser interface {
Name() string // markup format name
Extensions() []string
Render(rawBytes []byte, urlPrefix string, metas map[string]string, isWiki bool) []byte
}
Parser defines an interface for parsering markup file to HTML
func GetParserByFileName ¶ added in v1.3.0
func GetParserByFileName(filename string) Parser
GetParserByFileName get parser by filename
func GetParserByType ¶ added in v1.3.0
func GetParserByType(tp string) Parser
GetParserByType returns a parser according type