replacer

package module

v0.0.0-...-a2119cf Latest Latest Go to latest Published: Dec 26, 2019 License: MIT Imports: 6 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-text-replacer

Links

Open Source Insights

README ¶

goldmark-text-replacer

Goldmark text replacer extension.

md := goldmark.New(
    replacer.Options(
        "(c)", "&copy;",
        "(r)", "&reg;",
        "...", "&hellip;",
        "(tm)", "&trade;",
        "<-", "&larr;",
        "->", "&rarr;",
        "<->", "&harr;",
    ),
)
var source = []byte("(c)Dmitry Sedykh")
err := md.Convert(source, os.Stdout)
if err != nil {
    log.Fatal(err)
}

Documentation ¶

Overview ¶

Package replacer is a extension for the goldmark (http://github.com/yuin/goldmark).

This extension adds support for authomaticaly replacing text in markdowns.

Example ¶

package main

import (
	"log"
	"os"

	replacer "github.com/mdigger/goldmark-text-replacer"
	"github.com/yuin/goldmark"
)

func main() {
	md := goldmark.New(
		replacer.Options(
			"(c)", "&copy;",
			"(r)", "&reg;",
			"...", "&hellip;",
			"(tm)", "&trade;",
			"<-", "&larr;",
			"->", "&rarr;",
			"<->", "&harr;",
			"--", "&mdash;",
		),
	)
	var source = []byte("(c)Dmitry Sedykh")
	err := md.Convert(source, os.Stdout)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

<p>©Dmitry Sedykh</p>

Index ¶

func New(oldnew ...string) goldmark.Extender
func Options(oldnew ...string) goldmark.Option

Examples ¶

Package

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(oldnew ...string) goldmark.Extender

New returns a new Replacer from a list of old, new string pairs. Replacements are performed in the order they appear in the target string, without overlapping matches. The old string comparisons are done in argument order.

It's panics if given an odd number of arguments.

func Options ¶

func Options(oldnew ...string) goldmark.Option

Options return initialized text replacer goldmark.Option.

Types ¶

This section is empty.

Source Files ¶

View all Source files

replacer.go

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