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
- type Details
- type HTMLRenderer
- type Icon
- type RenderConfig
- type Renderer
- type Summary
- type TaskCheckBoxListItem
Constants ¶
This section is empty.
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 = "markdown"
MarkupName describes markup's name
Functions ¶
func ExtractMetadata ¶
ExtractMetadata consumes a markdown file, parses YAML frontmatter, and returns the frontmatter metadata separated from the markdown content
func IsDetails ¶
IsDetails returns true if the given node implements the Details interface, otherwise false.
func IsMarkdownFile ¶
IsMarkdownFile reports whether name looks like a Markdown file based on its extension.
func IsSummary ¶
IsSummary returns true if the given node implements the Summary interface, otherwise false.
func IsTaskCheckBoxListItem ¶
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 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.
type HTMLRenderer ¶
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 RenderConfig ¶
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 ¶
Extensions implements markup.Renderer
func (Renderer) NeedPostProcess ¶
NeedPostProcess implements markup.PostProcessRenderer
func (Renderer) SanitizerRules ¶
func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule
SanitizerRules implements markup.Renderer
type TaskCheckBoxListItem ¶
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.
Source Files