output

package

v0.1.2 Latest Latest Go to latest Published: Apr 12, 2019 License: GPL-3.0 Imports: 11 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/zhuxiaole/FictionDown

Documentation ¶

Index ¶

Variables
func MarkdownEscape(s string) string
func Output(src store.Store, format string, outpath string, opts Option) (err error)
func RegOutputFormat(s string, conv Conversion)
type Conversion
type EPUB
- func (t *EPUB) Conv(src store.Store, outpath string, opts Option) (err error)
type Markdown
- func (t *Markdown) Conv(src store.Store, outpath string, opts Option) (err error)
type MarkdownEPUBmeta
type MarkdownTemplateValues
type Option
type TXT
- func (t *TXT) Conv(src store.Store, outpath string, opts Option) (err error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrUnsupportFormat = fmt.Errorf("Unsupport Conversion Format")
)

View Source

var MarkdownTemplate = `` /* 484-byte string literal not displayed */

MarkdownTemplate is Markdown format Template

Parameters:
- `store`: Store.store
- `opts`: Options

View Source

var TxtTemplate = `` /* 273-byte string literal not displayed */

Functions ¶

func MarkdownEscape ¶

func MarkdownEscape(s string) string

func Output ¶

func Output(src store.Store, format string, outpath string, opts Option) (err error)

func RegOutputFormat ¶

func RegOutputFormat(s string, conv Conversion)

Types ¶

type Conversion ¶

type Conversion interface {
	Conv(src store.Store, outpath string, opts Option) error
}

type EPUB ¶

type EPUB struct {
}

func (*EPUB) Conv ¶

func (t *EPUB) Conv(src store.Store, outpath string, opts Option) (err error)

type Markdown ¶

type Markdown struct {
}

func (*Markdown) Conv ¶

func (t *Markdown) Conv(src store.Store, outpath string, opts Option) (err error)

type MarkdownEPUBmeta ¶

type MarkdownEPUBmeta struct {
	Title       string `yaml:"title"`
	Description string `yaml:"description"`
	Author      string `yaml:"creator"`
	Lang        string `yaml:"lang"`
	Cover       string `yaml:"cover-image"`
}

type MarkdownTemplateValues ¶

type MarkdownTemplateValues struct {
	Store    store.Store
	Opts     Option
	EPUBMeta MarkdownEPUBmeta
}

type Option ¶

type Option struct {
	IgnoreCover    bool // 忽略封面
	NoEPUBMetadata bool // 不添加EPUB元数据
}

Option is Convert output options

type TXT ¶

type TXT struct {
}

func (*TXT) Conv ¶

func (t *TXT) Conv(src store.Store, outpath string, opts Option) (err error)

Source Files ¶

View all Source files

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