renderhelper

Documentation

Index

• func NewRenderContextRepoComment(ctx context.Context, repo *repo_model.Repository, opts ...RepoCommentOptions) *markup.RenderContext
• func NewRenderContextRepoFile(ctx context.Context, repo *repo_model.Repository, opts ...RepoFileOptions) *markup.RenderContext
• func NewRenderContextRepoWiki(ctx context.Context, repo *repo_model.Repository, opts ...RepoWikiOptions) *markup.RenderContext
• func NewRenderContextSimpleDocument(ctx context.Context, baseLink string) *markup.RenderContext
• type RepoComment
  • func (r *RepoComment) CleanUp()
  • func (r *RepoComment) IsCommitIDExisting(commitID string) bool
  • func (r *RepoComment) ResolveLink(link string, likeType markup.LinkType) (finalLink string)
• type RepoCommentOptions
• type RepoFile
  • func (r *RepoFile) CleanUp()
  • func (r *RepoFile) IsCommitIDExisting(commitID string) bool
  • func (r *RepoFile) ResolveLink(link string, likeType markup.LinkType) string
• type RepoFileOptions
• type RepoWiki
  • func (r *RepoWiki) CleanUp()
  • func (r *RepoWiki) IsCommitIDExisting(commitID string) bool
  • func (r *RepoWiki) ResolveLink(link string, likeType markup.LinkType) string
• type RepoWikiOptions
• type SimpleDocument
  • func (r *SimpleDocument) ResolveLink(link string, likeType markup.LinkType) string

Functions

func NewRenderContextRepoComment

func NewRenderContextRepoComment(ctx context.Context, repo *repo_model.Repository, opts ...RepoCommentOptions) *markup.RenderContext

func NewRenderContextRepoFile

func NewRenderContextRepoFile(ctx context.Context, repo *repo_model.Repository, opts ...RepoFileOptions) *markup.RenderContext

func NewRenderContextRepoWiki

func NewRenderContextRepoWiki(ctx context.Context, repo *repo_model.Repository, opts ...RepoWikiOptions) *markup.RenderContext

func NewRenderContextSimpleDocument

func NewRenderContextSimpleDocument(ctx context.Context, baseLink string) *markup.RenderContext

Types

type RepoComment

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

func (*RepoComment) CleanUp

func (r *RepoComment) CleanUp()

func (*RepoComment) IsCommitIDExisting

func (r *RepoComment) IsCommitIDExisting(commitID string) bool

func (*RepoComment) ResolveLink

func (r *RepoComment) ResolveLink(link string, likeType markup.LinkType) (finalLink string)

type RepoCommentOptions

type RepoCommentOptions struct {
	DeprecatedRepoName  string // it is only a patch for the non-standard "markup" api
	DeprecatedOwnerName string // it is only a patch for the non-standard "markup" api
	CurrentRefPath      string // eg: "branch/main" or "commit/11223344"
}

type RepoFile

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

func (*RepoFile) CleanUp

func (r *RepoFile) CleanUp()

func (*RepoFile) IsCommitIDExisting

func (r *RepoFile) IsCommitIDExisting(commitID string) bool

func (*RepoFile) ResolveLink

func (r *RepoFile) ResolveLink(link string, likeType markup.LinkType) string

type RepoFileOptions

type RepoFileOptions struct {
	DeprecatedRepoName  string // it is only a patch for the non-standard "markup" api
	DeprecatedOwnerName string // it is only a patch for the non-standard "markup" api

	CurrentRefPath  string // eg: "branch/main"
	CurrentTreePath string // eg: "path/to/file" in the repo
}

type RepoWiki

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

func (*RepoWiki) CleanUp

func (r *RepoWiki) CleanUp()

func (*RepoWiki) IsCommitIDExisting

func (r *RepoWiki) IsCommitIDExisting(commitID string) bool

func (*RepoWiki) ResolveLink

func (r *RepoWiki) ResolveLink(link string, likeType markup.LinkType) string

type RepoWikiOptions

type RepoWikiOptions struct {
	DeprecatedRepoName  string // it is only a patch for the non-standard "markup" api
	DeprecatedOwnerName string // it is only a patch for the non-standard "markup" api
	// contains filtered or unexported fields
}

type SimpleDocument

type SimpleDocument struct {
	*markup.SimpleRenderHelper
	// contains filtered or unexported fields
}

func (*SimpleDocument) ResolveLink

func (r *SimpleDocument) ResolveLink(link string, likeType markup.LinkType) string