doc

package

v0.0.0-...-7b31a5f Latest Latest Go to latest Published: Nov 9, 2017 License: BSD-2-Clause 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

This section is empty.

This section is empty.

This section is empty.

type Doc struct {
	// contains filtered or unexported fields
}

Doc holds state used to create a documentation page.

func NewDoc() *Doc

func (d *Doc) AddAnchor(name string)

func (d *Doc) PopFold()

func (d *Doc) PopHighlight()

func (d *Doc) PopLink()

func (d *Doc) PushFold()

func (d *Doc) PushHighlight(group string)

func (d *Doc) PushLink(path string, line, column int)

func (d *Doc) PushLinkAnchor(path string, anchor string)

func (d *Doc) Write(p []byte) (int, error)

func (d *Doc) WriteLink(text string, path string, line, column int)

func (d *Doc) WriteLinkAnchor(text string, path, anchor string)

func (d *Doc) WriteString(s string) (int, error)

type Manager struct {
	// contains filtered or unexported fields
}

func NewManager(a *app.App) *Manager

func (m *Manager) Display(d *Doc, buf nvim.Buffer) error