formatter

package module

v0.0.0-...-23e60f5 Latest Latest Go to latest Published: Apr 4, 2022 License: MIT Imports: 19 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mdigger/goldmark-formatter

Links

Open Source Insights

README ¶

goldmark-formatter

This goldmark renderer extension adds support for formatting markdown.

source := []byte("# Title\nParagraph *em **bold*** [link](/).")
md := goldmark.New(
    goldmark.WithRenderer(formatter.Markdown), // markdown output
)
if err := md.Convert(source, os.Stdout); err != nil {
    log.Fatal(err)
}

Title
=====

Paragraph *em **bold*** [link](/).

Documentation ¶

Overview ¶

Example ¶

package main

import (
	"log"
	"os"

	formatter "github.com/mdigger/goldmark-formatter"
)

func main() {
	source := []byte("# Title\nParagraph *em **bold*** [link](/).")
	err := formatter.Format(source, os.Stdout)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

Title
=====

Paragraph _em **bold**_ [link](/).

Index ¶

Variables
func Format(source []byte, w io.Writer, opts ...parser.ParseOption) error
func Render(w io.Writer, source []byte, node ast.Node) (err error)

Examples ¶

Package

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	SkipHTML          = false
	STXHeader         = true
	LineBreak         = false
	UseListMarker     = true
	FencedCodeBlock   = "```"
	ThematicBreak     = "----"
	EntityReplacement = map[string]string{
		"&ldquo;":  `"`,
		"&rdquo;":  `"`,
		"&laquo;":  `"`,
		"&raquo;":  `"`,
		"&lsquo;":  `'`,
		"&rsquo;":  `'`,
		"&ndash;":  `--`,
		"&mdash;":  `---`,
		"&hellip;": `...`,
	}
	Logger = log.New(os.Stderr, "", 0)
)

Format settings

View Source

var Markdown renderer.Renderer = new(markdownRenderer)

Markdown is a markdown format renderer.

Functions ¶

func Format ¶

func Format(source []byte, w io.Writer, opts ...parser.ParseOption) error

Format write reformatted markdown source.

Use internal markdown parser with extensions GFM, DefinitionList, Footnote, LineBlocks, BlockAttributes and other.

func Render ¶

func Render(w io.Writer, source []byte, node ast.Node) (err error)

Render write node as Markdown o writer.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
mdfmt

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