replacer

package module
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 25, 2022 License: MIT Imports: 6 Imported by: 1

README

goldmark-replacer

Goldmark text replacer extension.

code

func Example() {
	md := goldmark.New(
		goldmark.WithExtensions(
			replacer.NewExtender(
				"(c)", "©",
				"(r)", "®",
				"...", "…",
				"(tm)", "™",
				"<-", "&larr;",
				"->", "&rarr;",
				"<->", "&harr;",
				"--", "&mdash;",
			),
		),
	)
	var source = []byte("(c)Dmitry Sedykh")
	err := md.Convert(source, os.Stdout)
	if err != nil {
		log.Fatal(err)
	}
}

view

<p>©Dmitry Sedykh</p>

thanks

Goldmark

goldmark-text-replacer

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/fundipper/goldmark-replacer"
	"github.com/yuin/goldmark"
)

func main() {
	md := goldmark.New(
		goldmark.WithExtensions(
			replacer.NewExtender(
				"(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

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewExtender

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

New return initialized image render with source url replacing support.

func NewRenderer

func NewRenderer() renderer.NodeRenderer

NewRenderer builds a new Renderer with given options and returns it.

Types

type Extender

type Extender struct {
	*strings.Replacer
}

func (*Extender) Extend

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

type Renderer

type Renderer struct {
	html.Config
}

Renderer struct is a renderer.NodeRenderer implementation for the extension.

func (*Renderer) RegisterFuncs

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

RegisterFuncs implements NodeRenderer.RegisterFuncs interface.

func (*Renderer) Replace

func (r *Renderer) Replace(source []byte) []byte

Jump to

Keyboard shortcuts

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