org

package

v0.5.12 Latest Latest Go to latest Published: Feb 18, 2024 License: Apache-2.0 Imports: 14 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/go-enjin/be

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type CDocument
- func NewOrgModeDocument(language, url, title string) (doc *CDocument)
type CFeature
type Document
type Feature
type MakeFeature
- func New() MakeFeature
- func NewTagged(tag feature.Tag) MakeFeature

Constants ¶

This section is empty.

Variables ¶

View Source

var Tag feature.Tag = "pages-formats-org"

Functions ¶

This section is empty.

Types ¶

type CDocument ¶

type CDocument struct {
	search.CDocument

	Links     []string `json:"links"`
	Headings  []string `json:"headings"`
	Footnotes []string `json:"footnotes"`
}

func NewOrgModeDocument ¶

func NewOrgModeDocument(language, url, title string) (doc *CDocument)

func (*CDocument) AddFootnote ¶

func (d *CDocument) AddFootnote(text string)

func (*CDocument) AddHeading ¶

func (d *CDocument) AddHeading(text string)

func (*CDocument) AddLink ¶

func (d *CDocument) AddLink(text string)

func (*CDocument) Self ¶

func (d *CDocument) Self() interface{}

type CFeature ¶

type CFeature struct {
	feature.CFeature
	// contains filtered or unexported fields
}

func (*CFeature) AddSearchDocumentMapping ¶

func (f *CFeature) AddSearchDocumentMapping(tag language.Tag, indexMapping *mapping.IndexMappingImpl)

func (*CFeature) Extensions ¶

func (f *CFeature) Extensions() (extensions []string)

func (*CFeature) IndexDocument ¶

func (f *CFeature) IndexDocument(pg feature.Page) (out interface{}, err error)

func (*CFeature) Init ¶

func (f *CFeature) Init(this interface{})

func (*CFeature) Label ¶

func (f *CFeature) Label() (label string)

func (*CFeature) Make ¶

func (f *CFeature) Make() Feature

func (*CFeature) Name ¶

func (f *CFeature) Name() (name string)

func (*CFeature) NewDocumentMapping ¶

func (f *CFeature) NewDocumentMapping(tag language.Tag) (doctype, analyzer string, dm *mapping.DocumentMapping)

func (*CFeature) Prepare ¶

func (f *CFeature) Prepare(ctx context.Context, content string) (out context.Context, err error)

func (*CFeature) Process ¶

func (f *CFeature) Process(ctx context.Context, content string) (html template.HTML, redirect string, err error)

func (*CFeature) RenderOrgMode ¶

func (f *CFeature) RenderOrgMode(content string) (rendered string, err error)

func (*CFeature) SearchDocumentMapping ¶

func (f *CFeature) SearchDocumentMapping(tag language.Tag) (doctype string, dm *mapping.DocumentMapping)

func (*CFeature) SetDefault ¶

func (f *CFeature) SetDefault(key, value string) MakeFeature

func (*CFeature) SetDefaults ¶

func (f *CFeature) SetDefaults(settings map[string]string) MakeFeature

func (*CFeature) Setup ¶ added in v0.2.0

func (f *CFeature) Setup(enjin feature.Internals)

type Document ¶

type Document interface {
	search.Document
	AddLink(text string)
	AddHeading(text string)
	AddFootnote(text string)
}

type Feature ¶

type Feature interface {
	feature.Feature
	feature.PageFormat
}

type MakeFeature ¶

type MakeFeature interface {
	// SetDefault updates org.Configuration.DefaultSettings
	SetDefault(key, value string) MakeFeature

	// SetDefaults replaces org.Configuration.DefaultSettings
	SetDefaults(defaults map[string]string) MakeFeature

	Make() Feature
}

func New ¶

func New() MakeFeature

func NewTagged ¶ added in v0.4.0

func NewTagged(tag feature.Tag) MakeFeature

Source Files ¶

View all Source files

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