img

package module
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: May 12, 2020 License: MIT Imports: 5 Imported by: 1

README

goldmark-image

Sync to Gitee w orkflow state codecov version

goldmark-image is an extension for goldmark.

Installation

go get -u github.com/OhYee/goldmark-image

Usage

See image_test.go

package main

import (
	"bytes"
	"fmt"
	img "github.com/OhYee/goldmark-image"
	"github.com/yuin/goldmark"
	"github.com/yuin/goldmark/extension"
	"github.com/yuin/goldmark/parser"
)

func main() {
	var buf bytes.Buffer
	source := []byte(`![Logo](https://www.oyohyee.com/static/img/logo.svg "title")`)

	md := goldmark.New(
	    goldmark.WithExtensions(
			img.NewImg("image", nil),
		),
	)

	if err := md.Convert(source, &buf); err != nil {
		panic(err)
	}
	fmt.Printf("%s\n", buf.Bytes())
}

License

MIT

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewImg

func NewImg(className string, renderWrapper RenderWrapperFunc) goldmark.Extender

NewImg initial a Img extension

Types

type Img

type Img struct {
	// contains filtered or unexported fields
}

Img extension

func (*Img) Extend

func (img *Img) Extend(m goldmark.Markdown)

Extend implements goldmark.Extender.

func (*Img) RegisterFuncs

func (img *Img) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

RegisterFuncs implements NodeRenderer.RegisterFuncs.

type ImgArgs

type ImgArgs struct {
	Title string
	Alt   string
	Src   string
}

ImgArgs arguments of Img

type RenderImgFunc

type RenderImgFunc func(args ImgArgs) string

RenderImgFunc render img function

type RenderWrapperFunc

type RenderWrapperFunc func(args ImgArgs, class string, renderImg RenderImgFunc) string

RenderWrapperFunc render wrapper function

Jump to

Keyboard shortcuts

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