epub

README

---

The goal of this fork is to make generation of novel epubs simple.

This is not a general purpose epub library, go to bmaupin/go-epub for that. If you want an epub library that can pull in markdown files and push out novels with chapters and automatically generated tables of contents, then this may be what you're looking for.

Features

• Forked from github.com/bmaupin/go-epub, but nearly completely rewritten
• Customizable templates for all the epub files
• Create chapters using Markdown or HTML
• Book-focused stylesheet
• Add an entire Images Folder instead of individual files

For an example of actual usage, see https://github.com/cahaba-ts/cahaba

Contributions

I'm not interested in generalizing the library in a way that complicates the novel workflow. Tweaks to the css file or fixes for bugs in specific epub applications would be helpful.

Development

Clone this repository using Git, it requires Go version 1.18 or higher.

Dependencies are managed using Go modules

Documentation

Index

• Variables
• func CompileTemplate(filename string) (*template.Template, error)
• func OverrideTemplate(filename string, content []byte)
• func RegisterShortcode(name string, handler ShortcodeHandler)
• func RetrieveTemplate(filename string) ([]byte, error)
• type Book
  • func NewBook(title string) *Book
  • func (e *Book) AddAsset(source, filename, mediaType string) error
  • func (e *Book) AddChapterHTML(title string, body []string) error
  • func (e *Book) AddChapterMD(title, body string) error
  • func (e *Book) AddImage(source, filename string) error
  • func (e *Book) AddImageFolder(source string) error
  • func (e *Book) AddIntroductionHTML(title string, body []string) error
  • func (e *Book) AddIntroductionMD(title string, body string) error
  • func (e *Book) AddMDExtension(ext goldmark.Extender)
  • func (e *Book) AddPostscriptHTML(title string, body []string) error
  • func (e *Book) AddPostscriptMD(title, body string) error
  • func (e *Book) Author() string
  • func (e *Book) Description() string
  • func (e *Book) Identifier() string
  • func (e *Book) LookupAsset(assetFilename string) (string, bool)
  • func (e *Book) LookupImage(imageFilename string) (string, bool)
  • func (e *Book) Publisher() string
  • func (e *Book) ReleaseDate() string
  • func (e *Book) SetAuthor(author string)
  • func (e *Book) SetCSS(source string) error
  • func (e *Book) SetCover(source string) error
  • func (e *Book) SetDescription(d string)
  • func (e *Book) SetIdentifier(id string)
  • func (e *Book) SetPublisher(pub string)
  • func (e *Book) SetReleaseDate(t string)
  • func (e *Book) SetTitle(t string)
  • func (e *Book) Title() string
  • func (e *Book) Write(filename string) error
• type FileRetrievalError
  • func (e *FileRetrievalError) Error() string
• type FilenameAlreadyUsedError
  • func (e *FilenameAlreadyUsedError) Error() string
• type ShortcodeHandler

Variables

var Debug = false

var ImageMediaTypes = map[string]string{
	".png":  "image/png",
	".jpg":  "image/jpeg",
	".jpeg": "image/jpeg",
	".svg":  "image/svg+xml",
	".webp": "image/webp",
	".jxl":  "image/jxl",
	".gif":  "image/gif",
	".heif": "image/heif",
	".avif": "image/avif",
}

Functions

func CompileTemplate

func CompileTemplate(filename string) (*template.Template, error)

func OverrideTemplate

func OverrideTemplate(filename string, content []byte)

OverrideTemplate will set a new template for the filename. Valid filenames are book.opf, chapter.xhtml, container.xml, cover.xhtml, main.css, toc.ncx, and toc.xhtml.

func RegisterShortcode

func RegisterShortcode(name string, handler ShortcodeHandler)

func RetrieveTemplate

func RetrieveTemplate(filename string) ([]byte, error)

RetrieveTemplate returns either the default template or an overridden template for the filename

Types

type Book

type Book struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Epub implements an EPUB file.

func NewBook

func NewBook(title string) *Book

NewBook returns a new Epub.

func (*Book) AddAsset

func (e *Book) AddAsset(source, filename, mediaType string) error

func (*Book) AddChapterHTML

func (e *Book) AddChapterHTML(title string, body []string) error

func (*Book) AddChapterMD

func (e *Book) AddChapterMD(title, body string) error

func (*Book) AddImage

func (e *Book) AddImage(source, filename string) error

func (*Book) AddImageFolder

func (e *Book) AddImageFolder(source string) error

func (*Book) AddIntroductionHTML

func (e *Book) AddIntroductionHTML(title string, body []string) error

func (*Book) AddIntroductionMD

func (e *Book) AddIntroductionMD(title string, body string) error

func (*Book) AddMDExtension

func (e *Book) AddMDExtension(ext goldmark.Extender)

AddMDExtension adds another extension to goldmark. Note that the Table, Strikethrough, and Definition List extensions are already added.

func (*Book) AddPostscriptHTML

func (e *Book) AddPostscriptHTML(title string, body []string) error

func (*Book) AddPostscriptMD

func (e *Book) AddPostscriptMD(title, body string) error

func (*Book) Author

func (e *Book) Author() string

func (*Book) Description

func (e *Book) Description() string

func (*Book) Identifier

func (e *Book) Identifier() string

func (*Book) LookupAsset

func (e *Book) LookupAsset(assetFilename string) (string, bool)

func (*Book) LookupImage

func (e *Book) LookupImage(imageFilename string) (string, bool)

func (*Book) Publisher

func (e *Book) Publisher() string

func (*Book) ReleaseDate

func (e *Book) ReleaseDate() string

func (*Book) SetAuthor

func (e *Book) SetAuthor(author string)

func (*Book) SetCSS

func (e *Book) SetCSS(source string) error

SetCSS will set the CSS file for the book. It is not recommended to call this more than once for a book.

func (*Book) SetCover

func (e *Book) SetCover(source string) error

func (*Book) SetDescription

func (e *Book) SetDescription(d string)

func (*Book) SetIdentifier

func (e *Book) SetIdentifier(id string)

func (*Book) SetPublisher

func (e *Book) SetPublisher(pub string)

func (*Book) SetReleaseDate

func (e *Book) SetReleaseDate(t string)

func (*Book) SetTitle

func (e *Book) SetTitle(t string)

func (*Book) Title

func (e *Book) Title() string

func (*Book) Write

func (e *Book) Write(filename string) error

type FileRetrievalError

type FileRetrievalError struct {
	Source string // The source of the file whose retrieval failed
	Err    error  // The underlying error that was thrown
}

FileRetrievalError is thrown by AddCSS, AddFont, AddImage, or Write if there was a problem retrieving the source file that was provided.

func (*FileRetrievalError) Error

func (e *FileRetrievalError) Error() string

type FilenameAlreadyUsedError

type FilenameAlreadyUsedError struct {
	Filename string // Filename that caused the error
}

FilenameAlreadyUsedError is thrown by AddCSS, AddFont, AddImage, or AddSection if the same filename is used more than once.

func (*FilenameAlreadyUsedError) Error

func (e *FilenameAlreadyUsedError) Error() string

type ShortcodeHandler

type ShortcodeHandler func(*Book, string, map[string]any, string) (string, error)