Help us shape the future of Go! Take the 2026 Go Developer Survey

renderhelper

package
v3.1.61 Latest Latest
Warning

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

Go to latest
Published: Jan 25, 2026 License: MIT, MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 (r *RepoComment) ResolveLink(link, preferLinkType string) 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"
	FootnoteContextID   string // the extra context ID for footnotes, used to avoid conflicts with other footnotes in the same page
}

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 (r *RepoFile) ResolveLink(link, preferLinkType string) (finalLink 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 (r *RepoWiki) ResolveLink(link, preferLinkType string) (finalLink 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 (r *SimpleDocument) ResolveLink(link, preferLinkType string) string

Source Files

  • commit_checker.go
  • repo_comment.go
  • repo_file.go
  • repo_wiki.go
  • simple_document.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL