Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

renderer

package

Go to main page

Versions in this module

v0

v0.8.0

Oct 22, 2022

Changes in this version

+ func Render(doc *types.Document, config *configuration.Configuration, output io.Writer) (types.Metadata, error)

v0.7.0

Mar 20, 2022

Changes in this version

type Context

+ SectionNumbering SectionNumbers

+ type SectionNumbers map[string]string

+ func NewSectionNumbers(doc *types.Document) (SectionNumbers, error)

v0.6.0

Mar 21, 2021

v0.5.1

Oct 4, 2020

v0.5.0

Oct 4, 2020

Changes in this version

type Context

+ EncodeSpecialChars bool

+ UseUnicode bool

v0.4.0

Apr 19, 2020

Changes in this version

type Context

+ Attributes types.DocumentAttributes

+ ElementReferences types.ElementReferences

+ Footnotes []types.Footnote

+ HasHeader bool

v0.3.0

Mar 14, 2020

Changes in this version

+ func Prerender(ctx Context) error

type Context

+ Config configuration.Configuration

+ TableOfContents types.TableOfContents

+ func IncludePreamble(ctx Context) Context

+ func IncludeTableOfContentsPlaceHolder(ctx Context) Context

+ func NewContext(document types.Document, config configuration.Configuration) Context

+ func ProcessDocumentHeader(ctx Context) Context

v0.2.0

Feb 24, 2019

v0.1.0

Jan 2, 2019

Changes in this version

+ const LastUpdatedFormat

+ type Context struct

+ Document types.Document

+ func Wrap(ctx context.Context, document types.Document, options ...Option) *Context

+ func (ctx *Context) Deadline() (deadline time.Time, ok bool)

+ func (ctx *Context) Done() <-chan struct{}

+ func (ctx *Context) Err() error

+ func (ctx *Context) GetAndIncrementExampleBlockCounter() int

+ func (ctx *Context) GetAndIncrementImageCounter() int

+ func (ctx *Context) GetAndIncrementTableCounter() int

+ func (ctx *Context) GetImagesDir() string

+ func (ctx *Context) IncludeBlankLine() bool

+ func (ctx *Context) IncludeHeaderFooter() bool

+ func (ctx *Context) LastUpdated() string

+ func (ctx *Context) SetIncludeBlankLine(b bool) bool

+ func (ctx *Context) SetWithinDelimitedBlock(b bool) bool

+ func (ctx *Context) SetWithinList(w bool)

+ func (ctx *Context) Value(key interface{}) interface{}

+ func (ctx *Context) WithinDelimitedBlock() bool

+ func (ctx *Context) WithinList() bool

+ type Option func(ctx *Context)

+ func Entrypoint(entrypoint string) Option

+ func IncludeHeaderFooter(value bool) Option

+ func LastUpdated(value time.Time) Option