markup

package
v1.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 13, 2026 License: MIT Imports: 38 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	IssueNameStyleNumeric      = "numeric"
	IssueNameStyleAlphanumeric = "alphanumeric"
	IssueNameStyleRegexp       = "regexp"
)

Issue name styles

View Source 
const (
	LinkTypeDefault = ""
	LinkTypeRoot    = "/:root"  // the link is relative to the AppSubURL(ROOT_URL)
	LinkTypeMedia   = "/:media" // the link should be used to access media files (images, videos)
	LinkTypeRaw     = "/:raw"   // not really useful, mainly for environment GITEA_PREFIX_RAW for external renders
)

Variables

View Source 
var RenderBehaviorForTesting struct {
	// Gitea will emit some additional attributes for various purposes, these attributes don't affect rendering.
	// But there are too many hard-coded test cases, to avoid changing all of them again and again, we can disable emitting these internal attributes.
	DisableAdditionalAttributes bool
}

Functions

func CamoEncode added in v1.27.0 

func CamoEncode(link string) string

CamoEncode encodes a lnk to fit with the go-camo and camo proxy links. The purposes of camo-proxy are: 1. Allow accessing "http://" images on a HTTPS site by using the "https://" URLs provided by camo-proxy. 2. Hide the visitor's real IP (protect privacy) when accessing external images.

func ComposeSimpleDocumentMetas added in v1.27.0 

func ComposeSimpleDocumentMetas() map[string]string

func CustomLinkURLSchemes added in v1.27.0 

func CustomLinkURLSchemes(schemes []string)

CustomLinkURLSchemes allows for additional schemes to be detected when parsing links within text

func DetectRendererTypeByPrefetch added in v1.27.0 

func DetectRendererTypeByPrefetch(filename string, sniffedType typesniffer.SniffedType, prefetchBuf []byte) string

DetectRendererTypeByPrefetch detects the markup type of the content

func Init added in v1.3.0 

func Init(renderHelpFuncs *RenderHelperFuncs)

Init initializes the render global variables

func IsFullURLString added in v1.27.0 

func IsFullURLString(link string) bool

func IsNonEmptyRelativePath added in v1.27.0 

func IsNonEmptyRelativePath(link string) bool
func ParseRenderedLink(s, preferLinkType string) (linkType, link string)

func PostProcessCommitMessage added in v1.27.0 

func PostProcessCommitMessage(ctx *RenderContext, content template.HTML) template.HTML

PostProcessCommitMessage will use the same logic as PostProcess, but will disable the shortLinkProcessor.

func PostProcessCommitMessageSubject added in v1.27.0 

func PostProcessCommitMessageSubject(ctx *RenderContext, defaultLink string, content template.HTML) template.HTML

PostProcessCommitMessageSubject will use the same logic as PostProcess and PostProcessCommitMessage, but will disable the shortLinkProcessor and emailAddressProcessor, and wraps the whole subject in defaultLink.

func PostProcessDefault added in v1.27.0 

func PostProcessDefault(ctx *RenderContext, input io.Reader, output io.Writer) error

PostProcessDefault 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 PostProcessDescriptionHTML added in v1.27.0 

func PostProcessDescriptionHTML(ctx *RenderContext, content template.HTML) template.HTML

PostProcessDescriptionHTML will use similar logic as PostProcess, but will use a single special linkProcessor.

func PostProcessEmoji added in v1.27.0 

func PostProcessEmoji(ctx *RenderContext, content template.HTML) template.HTML

PostProcessEmoji for when we want to just process emoji and shortcodes in various places it isn't already run through the normal Markdown processor

func PostProcessIssueTitle added in v1.27.0 

func PostProcessIssueTitle(ctx *RenderContext, titleHTML template.HTML) template.HTML

PostProcessIssueTitle to process title on individual issue/pull page

func PreviewableExtensions added in v1.27.0 

func PreviewableExtensions() []string

func RefreshFileNamePatterns added in v1.27.0 

func RefreshFileNamePatterns()

func RegisterRenderer added in v1.27.0 

func RegisterRenderer(renderer Renderer)

RegisterRenderer registers a new markup file renderer

func Render 

func Render(rctx *RenderContext, origInput io.Reader, output io.Writer) error

Render renders markup file to HTML with all specific handling stuff.

func RenderIFrame added in v1.27.0 

func RenderIFrame(ctx *RenderContext, opts *ExternalRendererOptions, output io.Writer) error

func RenderTocHeadingItems added in v1.27.0 

func RenderTocHeadingItems(ctx *RenderContext, nodeDetailsAttrs map[string]string, out io.Writer)

func RenderWithRenderer added in v1.27.0 

func RenderWithRenderer(ctx *RenderContext, renderer Renderer, input io.Reader, output io.Writer) error

func RendererNeedPostProcess added in v1.27.0 

func RendererNeedPostProcess(renderer Renderer) bool

func ResetDefaultSanitizerForTesting added in v1.27.0 

func ResetDefaultSanitizerForTesting()

func Sanitize added in v1.3.0 

func Sanitize(s string) template.HTML

Sanitize use default sanitizer policy to sanitize a string

func SanitizeDescription added in v1.27.0 

func SanitizeDescription(s string) string

SanitizeDescription sanitizes the HTML generated for a repository description.

func SanitizeReader added in v1.27.0 

func SanitizeReader(r io.Reader, renderer string, w io.Writer) error

SanitizeReader sanitizes a Reader

Types

type ExternalRenderer added in v1.27.0 

type ExternalRenderer interface {
	GetExternalRendererOptions() ExternalRendererOptions
}

ExternalRenderer defines an interface for external renderers

type ExternalRendererOptions added in v1.27.0 

type ExternalRendererOptions struct {
	SanitizerDisabled bool
	DisplayInIframe   bool
	ContentSandbox    string
}

func GetExternalRendererOptions added in v1.27.0 

func GetExternalRendererOptions(renderer Renderer) (ret ExternalRendererOptions, _ bool)

type PostProcessRenderer added in v1.27.0 

type PostProcessRenderer interface {
	NeedPostProcess() bool
}

PostProcessRenderer defines an interface for renderers who need post process

type RenderCodePreviewOptions added in v1.27.0 

type RenderCodePreviewOptions struct {
	FullURL   string
	OwnerName string
	RepoName  string
	CommitID  string
	FilePath  string

	LineStart, LineStop int
}

type RenderContext added in v1.27.0 

type RenderContext struct {
	TocShowInSection TocShowInSectionType
	TocHeadingItems  []*TocHeadingItem

	RenderHelper   RenderHelper
	RenderOptions  RenderOptions
	RenderInternal internal.RenderInternal
	// contains filtered or unexported fields
}

RenderContext represents a render context

func NewRenderContext added in v1.27.0 

func NewRenderContext(ctx context.Context) *RenderContext

func NewTestRenderContext added in v1.27.0 

func NewTestRenderContext(baseLinkOrMetas ...any) *RenderContext

NewTestRenderContext is a helper function to create a RenderContext for testing purpose It accepts string (BaseLink), map[string]string (Metas)

func (*RenderContext) Deadline added in v1.27.0 

func (ctx *RenderContext) Deadline() (deadline time.Time, ok bool)

func (*RenderContext) DetectMarkupRenderer added in v1.27.0 

func (ctx *RenderContext) DetectMarkupRenderer(prefetchBuf []byte) Renderer

func (*RenderContext) DetectMarkupRendererByReader added in v1.27.0 

func (ctx *RenderContext) DetectMarkupRendererByReader(in io.Reader) (Renderer, io.Reader, error)

func (*RenderContext) Done added in v1.27.0 

func (ctx *RenderContext) Done() <-chan struct{}

func (*RenderContext) Err added in v1.27.0 

func (ctx *RenderContext) Err() error

func (*RenderContext) ResolveLinkRelative added in v1.27.0 

func (ctx *RenderContext) ResolveLinkRelative(base, cur, link string) string

func (*RenderContext) ResolveLinkRoot added in v1.27.0 

func (ctx *RenderContext) ResolveLinkRoot(link string) string

func (*RenderContext) Value added in v1.27.0 

func (ctx *RenderContext) Value(key any) any

func (*RenderContext) WithEnableHeadingIDGeneration added in v1.27.0 

func (ctx *RenderContext) WithEnableHeadingIDGeneration(v bool) *RenderContext

func (*RenderContext) WithHelper added in v1.27.0 

func (ctx *RenderContext) WithHelper(helper RenderHelper) *RenderContext

func (*RenderContext) WithMarkupType added in v1.27.0 

func (ctx *RenderContext) WithMarkupType(typ string) *RenderContext

func (*RenderContext) WithMetas added in v1.27.0 

func (ctx *RenderContext) WithMetas(metas map[string]string) *RenderContext

func (*RenderContext) WithRelativePath added in v1.27.0 

func (ctx *RenderContext) WithRelativePath(path string) *RenderContext

func (*RenderContext) WithStandalonePage added in v1.27.0 

func (ctx *RenderContext) WithStandalonePage(opts StandalonePageOptions) *RenderContext
func (ctx *RenderContext) WithUseAbsoluteLink(v bool) *RenderContext

type RenderHelper added in v1.27.0 

type RenderHelper interface {
	CleanUp()

	IsCommitIDExisting(commitID string) bool
	ResolveLink(link, preferLinkType string) string
}

type RenderHelperFuncs added in v1.27.0 

type RenderHelperFuncs struct {
	IsUsernameMentionable     func(ctx context.Context, username string) bool
	RenderRepoFileCodePreview func(ctx context.Context, options RenderCodePreviewOptions) (template.HTML, error)
	RenderRepoIssueIconTitle  func(ctx context.Context, options RenderIssueIconTitleOptions) (template.HTML, error)
}

RenderHelperFuncs is used to decouple cycle-import At the moment there are different packages: modules/markup: basic markup rendering models/renderhelper: need to access models and git repo, and models/issues needs it services/markup: some real helper functions could only be provided here because it needs to access various services & templates 

var DefaultRenderHelperFuncs *RenderHelperFuncs

type RenderIssueIconTitleOptions added in v1.27.0 

type RenderIssueIconTitleOptions struct {
	OwnerName  string
	RepoName   string
	LinkHref   string
	IssueIndex int64
}

type RenderMetaMode added in v1.27.0 

type RenderMetaMode string
const (
	RenderMetaAsDetails RenderMetaMode = "details" // default
	RenderMetaAsNone    RenderMetaMode = "none"
	RenderMetaAsTable   RenderMetaMode = "table"
)

type RenderOptions added in v1.27.0 

type RenderOptions struct {
	UseAbsoluteLink bool

	// relative path from tree root of the branch
	RelativePath string

	// eg: "orgmode", "asciicast", "console"
	// for file mode, it could be left as empty, and will be detected by file extension in RelativePath
	MarkupType string

	// user&repo, format&style&regexp (for external issue pattern), teams&org (for mention)
	// RefTypeNameSubURL (for iframe&asciicast)
	// markupAllowShortIssuePattern
	// markdownNewLineHardBreak
	Metas map[string]string

	// used by external render. the router "/org/repo/render/..." will output the rendered content in a standalone page
	StandalonePageOptions *StandalonePageOptions

	// EnableHeadingIDGeneration controls whether to auto-generate IDs for HTML headings without id attribute.
	// This should be enabled for repository files and wiki pages, but disabled for comments to avoid duplicate IDs.
	EnableHeadingIDGeneration bool
}

type Renderer added in v1.27.0 

type Renderer interface {
	Name() string // markup format name, also the renderer type, also the external tool name
	FileNamePatterns() []string
	SanitizerRules() []setting.MarkupSanitizerRule
	Render(ctx *RenderContext, input io.Reader, output io.Writer) error
}

Renderer defines an interface for rendering markup file to HTML

func DetectRendererTypeByFilename added in v1.27.0 

func DetectRendererTypeByFilename(filename string) Renderer

type RendererContentDetector added in v1.27.0 

type RendererContentDetector interface {
	CanRender(filename string, sniffedType typesniffer.SniffedType, prefetchBuf []byte) bool
}

RendererContentDetector detects if the content can be rendered by specified renderer

type Sanitizer added in v1.3.0 

type Sanitizer struct {
	// contains filtered or unexported fields
}

Sanitizer is a protection wrapper of *bluemonday.Policy which does not allow any modification to the underlying policies once it's been created.

func GetDefaultSanitizer added in v1.27.0 

func GetDefaultSanitizer() *Sanitizer

type SimpleRenderHelper added in v1.27.0 

type SimpleRenderHelper struct{}

func (*SimpleRenderHelper) CleanUp added in v1.27.0 

func (r *SimpleRenderHelper) CleanUp()

func (*SimpleRenderHelper) IsCommitIDExisting added in v1.27.0 

func (r *SimpleRenderHelper) IsCommitIDExisting(commitID string) bool
func (r *SimpleRenderHelper) ResolveLink(link, preferLinkType string) string

type StandalonePageOptions added in v1.27.0 

type StandalonePageOptions struct {
	CurrentWebTheme   WebThemeInterface
	RenderQueryString string
}

type TestRenderHelper added in v1.27.0 

type TestRenderHelper struct {
	BaseLink string
	// contains filtered or unexported fields
}

func (*TestRenderHelper) CleanUp added in v1.27.0 

func (r *TestRenderHelper) CleanUp()

func (*TestRenderHelper) IsCommitIDExisting added in v1.27.0 

func (r *TestRenderHelper) IsCommitIDExisting(commitID string) bool
func (r *TestRenderHelper) ResolveLink(link, preferLinkType string) string

type TocHeadingItem added in v1.27.0 

type TocHeadingItem struct {
	HeadingLevel int
	AnchorID     string
	InnerText    string
}

type TocShowInSectionType added in v1.27.0 

type TocShowInSectionType string
const (
	TocShowInSidebar TocShowInSectionType = "sidebar"
	TocShowInMain    TocShowInSectionType = "main"
)

type WebThemeInterface added in v1.27.0 

type WebThemeInterface interface {
	PublicAssetURI() string
}

Source Files

View all Source files

Directories

Path Synopsis
math

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.