Documentation ¶
Index ¶
- Constants
- Variables
- func TransformExternalLinkToPlain(raw []rune, ptr int) (advance int, tobewritten []rune, err error)
- func TransformInternalLinkToPlain(raw []rune, ptr int) (advance int, tobewritten []rune, err error)
- func TransformNone(raw []rune, ptr int) (advance int, tobewritten []rune, err error)
- type Converter
- func NewCommentEraser() *Converter
- func NewH1Remover() *Converter
- func NewLinkConverter(db PathDB, anchorFormattingStyle string) *Converter
- func NewLinkPlainConverter() *Converter
- func NewTagFinder(tags map[string]struct{}) *Converter
- func NewTagRemover() *Converter
- func NewTitleFinder(title *string) *Converter
- type EmbedsTransformer
- type EmbedsTransformerImpl
- type ErrConvert
- type ErrKind
- type ErrTransform
- type ExternalLinkTransformer
- type ExternalLinkTransformerImpl
- type InternalLinkTransformer
- type InternalLinkTransformerImpl
- type PathDB
- func NewPathDB(vault string) PathDB
- func WrapForEncodingPaths(original PathDB) PathDB
- func WrapForRemappingPathPrefix(pathPrefixRemap map[string]string, original PathDB) PathDB
- func WrapForReturningNotFoundPathError(original PathDB) PathDB
- func WrapForTrimmingSuffixMd(original PathDB) PathDB
- func WrapForUsingSelfForEmptyFileId(selfPath string, original PathDB) PathDB
- type ScannerFunc
- type TransformerFunc
Constants ¶
View Source
const FORMAT_ANCHOR_HUGO = "hugo"
View Source
const FORMAT_ANCHOR_MARKDOWN_IT = "markdownit"
Variables ¶
View Source
var ANCHOR_FORMATTING_STYLES = []string{FORMAT_ANCHOR_HUGO, FORMAT_ANCHOR_MARKDOWN_IT}
Functions ¶
Types ¶
type Converter ¶
type Converter struct {
// contains filtered or unexported fields
}
func NewCommentEraser ¶
func NewCommentEraser() *Converter
func NewH1Remover ¶
func NewH1Remover() *Converter
func NewLinkConverter ¶
func NewLinkPlainConverter ¶
func NewLinkPlainConverter() *Converter
func NewTagFinder ¶
func NewTagRemover ¶
func NewTagRemover() *Converter
func NewTitleFinder ¶
func (*Converter) Set ¶
func (c *Converter) Set(t TransformerFunc)
type EmbedsTransformer ¶
type EmbedsTransformerImpl ¶
type EmbedsTransformerImpl struct {
PathDB
}
func (*EmbedsTransformerImpl) TransformEmbeds ¶
func (t *EmbedsTransformerImpl) TransformEmbeds(content string) (emnbeddedLink string, err error)
type ErrConvert ¶
type ErrTransform ¶
type ExternalLinkTransformer ¶
type ExternalLinkTransformerImpl ¶
type ExternalLinkTransformerImpl struct {
PathDB
}
func (*ExternalLinkTransformerImpl) TransformExternalLink ¶
func (t *ExternalLinkTransformerImpl) TransformExternalLink(displayName, ref string, title string) (externalLink string, err error)
type InternalLinkTransformer ¶
type InternalLinkTransformerImpl ¶
type InternalLinkTransformerImpl struct { PathDB // contains filtered or unexported fields }
func (*InternalLinkTransformerImpl) TransformInternalLink ¶
func (t *InternalLinkTransformerImpl) TransformInternalLink(content string) (externalLink string, err error)
type PathDB ¶
func WrapForEncodingPaths ¶ added in v0.3.1
func WrapForRemappingPathPrefix ¶ added in v0.3.0
func WrapForTrimmingSuffixMd ¶ added in v0.3.0
func WrapForUsingSelfForEmptyFileId ¶ added in v0.3.0
type ScannerFunc ¶
type TransformerFunc ¶
func MiddlewareAsIs ¶
func MiddlewareAsIs(scanner ScannerFunc) TransformerFunc
func TransformEmnbedsFunc ¶
func TransformEmnbedsFunc(t EmbedsTransformer) TransformerFunc
func TransformExternalLinkFunc ¶
func TransformExternalLinkFunc(t ExternalLinkTransformer) TransformerFunc
func TransformInternalLinkFunc ¶
func TransformInternalLinkFunc(t InternalLinkTransformer) TransformerFunc
Click to show internal directories.
Click to hide internal directories.