markdown

package

v1.0.3 Latest Latest Go to latest Published: Apr 30, 2020 License: MIT Imports: 7 Imported by: 0

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/Qs-F/gen

Links

Open Source Insights

Documentation ¶

Overview ¶

Package markdown is the expander for markdown to html

Index ¶

Variables
type Markdown
- func New(layoutKey, htmlKey, contentKey string, list gen.List) *Markdown
- func (m *Markdown) Expand(p []byte, v gen.Variables) ([]byte, error)
- func (_ *Markdown) Ext() (string, string)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrLayoutFileNotFound is retunred when layout file is not found in list
	ErrLayoutFileNotFound = errors.New("No such layout file is found")
)

Functions ¶

This section is empty.

Types ¶

type Markdown ¶

type Markdown struct {
	LayoutKey  string
	HTMLKey    string
	ContentKey string
	List       gen.List
}

Markdown satisfies gen.Expander

func New ¶

func New(layoutKey, htmlKey, contentKey string, list gen.List) *Markdown

New returns new instance of Markdown. layoutKey is ident of layout file in markdown file. htmlKey is Variables key of content for html loader. contentKey is content ident in html file for markdown content.

func (*Markdown) Expand ¶

func (m *Markdown) Expand(p []byte, v gen.Variables) ([]byte, error)

Expand implements gen.Expander

func (*Markdown) Ext ¶

func (_ *Markdown) Ext() (string, string)

Ext implements gen.Expander

Source Files ¶

View all Source files

expand.go

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