markup

type ExternalRenderer interface {
	GetExternalRendererOptions() ExternalRendererOptions
}

type ExternalRendererOptions struct {
	SanitizerDisabled bool
	DisplayInIframe   bool
	ContentSandbox    string
}

type PostProcessRenderer interface {
	NeedPostProcess() bool
}

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

	LineStart, LineStop int
}

type RenderContext struct {
	TocShowInSection TocShowInSectionType
	TocHeadingItems  []*TocHeadingItem

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

type RenderHelper interface {
	CleanUp()

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

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)
}

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

type RenderMetaMode string

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 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
}

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

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

type SimpleRenderHelper struct{}

type StandalonePageOptions struct {
	CurrentWebTheme   WebThemeInterface
	RenderQueryString string
}

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

type TocHeadingItem struct {
	HeadingLevel int
	AnchorID     string
	InnerText    string
}

type TocShowInSectionType string

type WebThemeInterface interface {
	PublicAssetURI() string
}