markdown

Documentation

Index

• Variables
• func ExtractMetadata(contents string, out interface{}) (string, error)
• func IsDetails(node ast.Node) bool
• func IsIcon(node ast.Node) bool
• func IsMarkdownFile(name string) bool
• func IsSummary(node ast.Node) bool
• func IsTaskCheckBoxListItem(node ast.Node) bool
• func NewHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
• func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error
• func RenderRaw(ctx *markup.RenderContext, input io.Reader, output io.Writer) error
• func RenderRawString(ctx *markup.RenderContext, content string) (string, error)
• func RenderString(ctx *markup.RenderContext, content string) (string, error)
• type ASTTransformer
  • func (g *ASTTransformer) Transform(node *ast.Document, reader text.Reader, pc parser.Context)
• type Details
  • func NewDetails() *Details
  • func (n *Details) Dump(source []byte, level int)
  • func (n *Details) Kind() ast.NodeKind
• type HTMLRenderer
  • func (r *HTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type Header
• type Icon
  • func NewIcon(name string) *Icon
  • func (n *Icon) Dump(source []byte, level int)
  • func (n *Icon) Kind() ast.NodeKind
• type RenderConfig
  • func (rc *RenderConfig) ToRenderConfig(meta yaml.MapSlice)
• type Renderer
  • func (Renderer) Extensions() []string
  • func (Renderer) Name() string
  • func (Renderer) NeedPostProcess() bool
  • func (Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error
  • func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule
• type Summary
  • func NewSummary() *Summary
  • func (n *Summary) Dump(source []byte, level int)
  • func (n *Summary) Kind() ast.NodeKind
• type TaskCheckBoxListItem
  • func NewTaskCheckBoxListItem(listItem *ast.ListItem) *TaskCheckBoxListItem
  • func (n *TaskCheckBoxListItem) Dump(source []byte, level int)
  • func (n *TaskCheckBoxListItem) Kind() ast.NodeKind

Variables

var KindDetails = ast.NewNodeKind("Details")

KindDetails is the NodeKind for Details

var KindIcon = ast.NewNodeKind("Icon")

KindIcon is the NodeKind for Icon

var KindSummary = ast.NewNodeKind("Summary")

KindSummary is the NodeKind for Summary

var KindTaskCheckBoxListItem = ast.NewNodeKind("TaskCheckBoxListItem")

KindTaskCheckBoxListItem is the NodeKind for TaskCheckBoxListItem

var (
	// MarkupName describes markup's name
	MarkupName = "markdown"
)

Functions

func ExtractMetadata

func ExtractMetadata(contents string, out interface{}) (string, error)

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

func IsDetails

func IsDetails(node ast.Node) bool

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

func IsIcon

func IsIcon(node ast.Node) bool

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

func IsMarkdownFile

func IsMarkdownFile(name string) bool

IsMarkdownFile reports whether name looks like a Markdown file based on its extension.

func IsSummary

func IsSummary(node ast.Node) bool

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

func IsTaskCheckBoxListItem

func IsTaskCheckBoxListItem(node ast.Node) bool

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

func NewHTMLRenderer

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

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

Types

type ASTTransformer

type ASTTransformer struct{}

ASTTransformer is a default transformer of the goldmark tree.

func (*ASTTransformer) Transform

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

Transform transforms the given AST tree.

type Details

type Details struct {
	ast.BaseBlock
}

Details is a block that contains Summary and details

func NewDetails

func NewDetails() *Details

NewDetails returns a new Paragraph node.

func (*Details) Dump

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

Dump implements Node.Dump .

func (*Details) Kind

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

Kind implements Node.Kind.

type HTMLRenderer

type HTMLRenderer struct {
	html.Config
}

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

func (*HTMLRenderer) RegisterFuncs

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type Header

type Header struct {
	Level int
	Text  string
	ID    string
}

Header holds the data about a header.

type Icon

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

Icon is an inline for a fomantic icon

func NewIcon

func NewIcon(name string) *Icon

NewIcon returns a new Paragraph node.

func (*Icon) Dump

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

Dump implements Node.Dump .

func (*Icon) Kind

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

Kind implements Node.Kind.

type RenderConfig

type RenderConfig struct {
	Meta string
	Icon string
	TOC  bool
	Lang string
}

RenderConfig represents rendering configuration for this file

func (*RenderConfig) ToRenderConfig

func (rc *RenderConfig) ToRenderConfig(meta yaml.MapSlice)

ToRenderConfig converts a yaml.MapSlice to a RenderConfig

type Renderer

type Renderer struct{}

Renderer implements markup.Renderer

func (Renderer) Extensions

func (Renderer) Extensions() []string

Extensions implements markup.Renderer

func (Renderer) Name

func (Renderer) Name() string

Name implements markup.Renderer

func (Renderer) NeedPostProcess

func (Renderer) NeedPostProcess() bool

NeedPostProcess implements markup.Renderer

func (Renderer) Render

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

Render implements markup.Renderer

func (Renderer) SanitizerRules

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

SanitizerRules implements markup.Renderer

type Summary

type Summary struct {
	ast.BaseBlock
}

Summary is a block that contains the summary of details block

func NewSummary

func NewSummary() *Summary

NewSummary returns a new Summary node.

func (*Summary) Dump

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

Dump implements Node.Dump .

func (*Summary) Kind

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

Kind implements Node.Kind.

type TaskCheckBoxListItem

type TaskCheckBoxListItem struct {
	*ast.ListItem
	IsChecked bool
}

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

func NewTaskCheckBoxListItem

func NewTaskCheckBoxListItem(listItem *ast.ListItem) *TaskCheckBoxListItem

NewTaskCheckBoxListItem returns a new TaskCheckBoxListItem node.

func (*TaskCheckBoxListItem) Dump

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

Dump implements Node.Dump .

func (*TaskCheckBoxListItem) Kind

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

Kind implements Node.Kind.