manpage

package

v0.2.6 Latest Latest Go to latest Published: Oct 6, 2025 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

git.alin.ovh/searchix

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func New() goldmark.Extender
func NewHTMLRenderer(opts ...html.Option) renderer.NodeRenderer
type Extension
- func (e *Extension) Extend(m goldmark.Markdown)
type HTMLRenderer
- func (r *HTMLRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
type Node
type Parser
- func (p *Parser) Parse(_ ast.Node, block text.Reader, _ parser.Context) ast.Node
- func (*Parser) Trigger() []byte

Constants ¶

This section is empty.

Variables ¶

View Source

var KindManPage = ast.NewNodeKind("ManPage")

KindManPage is a NodeKind for manpage nodes.

Functions ¶

func New ¶

func New() goldmark.Extender

New returns a new manpage extension.

func NewHTMLRenderer ¶

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

NewHTMLRenderer returns a new HTMLRenderer.

Types ¶

type Extension ¶

type Extension struct{}

Extension is a goldmark extension for manpage references.

func (*Extension) Extend ¶

func (e *Extension) Extend(m goldmark.Markdown)

Extend implements goldmark.Extender.Extend.

type HTMLRenderer ¶

type HTMLRenderer struct {
	html.Config
}

HTMLRenderer is a renderer for manpage nodes.

func (*HTMLRenderer) RegisterFuncs ¶

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

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type Node ¶

type Node struct {
	ast.BaseInline
	ManPage []byte
}

Node represents a manpage reference node in markdown AST.

func (*Node) Dump ¶

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

Dump implements ast.Node.Dump interface.

func (*Node) Inline ¶

func (n *Node) Inline() bool

Inline implements ast.Inline interface.

func (*Node) Kind ¶

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

Kind implements ast.Node.Kind interface.

type Parser ¶

type Parser struct{}

Parser is a Goldmark inline parser for parsing manpage nodes.

Manpage references have the format {manpage}`nix.conf(5)` which will be rendered as a link to the manpage with the appropriate section.

func (*Parser) Parse ¶

func (p *Parser) Parse(_ ast.Node, block text.Reader, _ parser.Context) ast.Node

Parse parses a manpage node.

func (*Parser) Trigger ¶

func (*Parser) Trigger() []byte

Trigger reports characters that trigger this parser.

Source Files ¶

View all Source files

manpage.go

Directories ¶

Path	Synopsis
example

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