markdown

package
v1.21.11 Latest Latest
Warning

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

 Go to latest Published: Apr 16, 2024 License: MIT Imports: 34 Imported by: 226

Documentation

Index

Constants

View Source 
const (
	AttentionNote    string = "Note"
	AttentionWarning string = "Warning"
)

Variables

View Source 
var KindAttention = ast.NewNodeKind("Attention")

KindAttention is the NodeKind for Attention

View Source 
var KindColorPreview = ast.NewNodeKind("ColorPreview")

KindColorPreview is the NodeKind for ColorPreview

View Source 
var KindDetails = ast.NewNodeKind("Details")

KindDetails is the NodeKind for Details

View Source 
var KindIcon = ast.NewNodeKind("Icon")

KindIcon is the NodeKind for Icon

View Source 
var KindSummary = ast.NewNodeKind("Summary")

KindSummary is the NodeKind for Summary

View Source 
var KindTaskCheckBoxListItem = ast.NewNodeKind("TaskCheckBoxListItem")

KindTaskCheckBoxListItem is the NodeKind for TaskCheckBoxListItem

View Source 
var MarkupName = "markdown"

MarkupName describes markup's name

Functions

func ExtractMetadata added in v1.13.0 

func ExtractMetadata(contents string, out any) (string, error)

ExtractMetadata consumes a markdown file, parses YAML frontmatter, and returns the frontmatter metadata separated from the markdown content

func ExtractMetadataBytes added in v1.17.4 

func ExtractMetadataBytes(contents []byte, out any) ([]byte, error)

ExtractMetadata consumes a markdown file, parses YAML frontmatter, and returns the frontmatter metadata separated from the markdown content

func IsColorPreview added in v1.17.4 

func IsColorPreview(node ast.Node) bool

IsColorPreview returns true if the given node implements the ColorPreview interface, otherwise false.

func IsDetails added in v1.12.0 

func IsDetails(node ast.Node) bool

IsDetails returns true if the given node implements the Details interface, otherwise false.

func IsIcon added in v1.12.0 

func IsIcon(node ast.Node) bool

IsIcon returns true if the given node implements the Icon interface, otherwise false.

func IsSummary added in v1.12.0 

func IsSummary(node ast.Node) bool

IsSummary returns true if the given node implements the Summary interface, otherwise false.

func IsTaskCheckBoxListItem added in v1.12.0 

func IsTaskCheckBoxListItem(node ast.Node) bool

IsTaskCheckBoxListItem returns true if the given node implements the TaskCheckBoxListItem interface, otherwise false.

func NewHTMLRenderer added in v1.12.0 

func NewHTMLRenderer(opts ...html.Option) renderer.NodeRenderer

NewHTMLRenderer creates a HTMLRenderer to render in the gitea form.

func Render 

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

Render renders Markdown to HTML with all specific handling stuff.

func RenderRaw 

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

RenderRaw renders Markdown to HTML without handling special links.

func RenderRawString added in v1.15.0 

func RenderRawString(ctx *markup.RenderContext, content string) (string, error)

RenderRawString renders Markdown to HTML without handling special links and return string

func RenderString 

func RenderString(ctx *markup.RenderContext, content string) (string, error)

RenderString renders Markdown string to HTML with all specific handling stuff and return string

func SpecializedMarkdown added in v1.20.0 

func SpecializedMarkdown() goldmark.Markdown

SpecializedMarkdown sets up the Gitea specific markdown extensions

Types

type ASTTransformer added in v1.12.0 

type ASTTransformer struct{}

ASTTransformer is a default transformer of the goldmark tree.

func (*ASTTransformer) Transform added in v1.12.0 

func (g *ASTTransformer) Transform(node *ast.Document, reader text.Reader, pc parser.Context)

Transform transforms the given AST tree.

type Attention added in v1.17.4 

type Attention struct {
	ast.BaseInline
	AttentionType string
}

Attention is an inline for a color preview

func NewAttention added in v1.17.4 

func NewAttention(attentionType string) *Attention

NewAttention returns a new Attention node.

func (*Attention) Dump added in v1.17.4 

func (n *Attention) Dump(source []byte, level int)

Dump implements Node.Dump.

func (*Attention) Kind added in v1.17.4 

func (n *Attention) Kind() ast.NodeKind

Kind implements Node.Kind.

type ColorPreview added in v1.17.4 

type ColorPreview struct {
	ast.BaseInline
	Color []byte
}

ColorPreview is an inline for a color preview

func NewColorPreview added in v1.17.4 

func NewColorPreview(color []byte) *ColorPreview

NewColorPreview returns a new Span node.

func (*ColorPreview) Dump added in v1.17.4 

func (n *ColorPreview) Dump(source []byte, level int)

Dump implements Node.Dump.

func (*ColorPreview) Kind added in v1.17.4 

func (n *ColorPreview) Kind() ast.NodeKind

Kind implements Node.Kind.

type Details added in v1.12.0 

type Details struct {
	ast.BaseBlock
}

Details is a block that contains Summary and details

func NewDetails added in v1.12.0 

func NewDetails() *Details

NewDetails returns a new Paragraph node.

func (*Details) Dump added in v1.12.0 

func (n *Details) Dump(source []byte, level int)

Dump implements Node.Dump .

func (*Details) Kind added in v1.12.0 

func (n *Details) Kind() ast.NodeKind

Kind implements Node.Kind.

type HTMLRenderer added in v1.12.0 

type HTMLRenderer struct {
	html.Config
}

HTMLRenderer is a renderer.NodeRenderer implementation that renders gitea specific features.

func (*HTMLRenderer) RegisterFuncs added in v1.12.0 

func (r *HTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type Icon added in v1.12.0 

type Icon struct {
	ast.BaseInline
	Name []byte
}

Icon is an inline for a fomantic icon

func NewIcon added in v1.12.0 

func NewIcon(name string) *Icon

NewIcon returns a new Paragraph node.

func (*Icon) Dump added in v1.12.0 

func (n *Icon) Dump(source []byte, level int)

Dump implements Node.Dump .

func (*Icon) Kind added in v1.12.0 

func (n *Icon) Kind() ast.NodeKind

Kind implements Node.Kind.

type RenderConfig added in v1.12.0 

type RenderConfig struct {
	Meta markup.RenderMetaMode
	Icon string
	TOC  string // "false": hide,  "side"/empty: in sidebar,  "main"/"true": in main view
	Lang string
	// contains filtered or unexported fields
}

RenderConfig represents rendering configuration for this file

func (*RenderConfig) UnmarshalYAML added in v1.17.4 

func (rc *RenderConfig) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML implement yaml.v3 UnmarshalYAML

type Renderer 

type Renderer struct{}

Renderer implements markup.Renderer

func (Renderer) Extensions added in v1.15.0 

func (Renderer) Extensions() []string

Extensions implements markup.Renderer

func (Renderer) Name added in v1.15.0 

func (Renderer) Name() string

Name implements markup.Renderer

func (Renderer) NeedPostProcess added in v1.15.0 

func (Renderer) NeedPostProcess() bool

NeedPostProcess implements markup.PostProcessRenderer

func (Renderer) Render added in v1.15.0 

func (Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error

Render implements markup.Renderer

func (Renderer) SanitizerRules added in v1.15.0 

func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule

SanitizerRules implements markup.Renderer

type Summary added in v1.12.0 

type Summary struct {
	ast.BaseBlock
}

Summary is a block that contains the summary of details block

func NewSummary added in v1.12.0 

func NewSummary() *Summary

NewSummary returns a new Summary node.

func (*Summary) Dump added in v1.12.0 

func (n *Summary) Dump(source []byte, level int)

Dump implements Node.Dump .

func (*Summary) Kind added in v1.12.0 

func (n *Summary) Kind() ast.NodeKind

Kind implements Node.Kind.

type TaskCheckBoxListItem added in v1.12.0 

type TaskCheckBoxListItem struct {
	*ast.ListItem
	IsChecked      bool
	SourcePosition int
}

TaskCheckBoxListItem is a block that represents a list item of a markdown block with a checkbox

func NewTaskCheckBoxListItem added in v1.12.0 

func NewTaskCheckBoxListItem(listItem *ast.ListItem) *TaskCheckBoxListItem

NewTaskCheckBoxListItem returns a new TaskCheckBoxListItem node.

func (*TaskCheckBoxListItem) Dump added in v1.12.0 

func (n *TaskCheckBoxListItem) Dump(source []byte, level int)

Dump implements Node.Dump .

func (*TaskCheckBoxListItem) Kind added in v1.12.0 

func (n *TaskCheckBoxListItem) Kind() ast.NodeKind

Kind implements Node.Kind.

Source Files

View all Source files

Directories

Path Synopsis

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.