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.1.6

Jul 11, 2024

Changes in this version

type AsciidoctorRenderer

+ func (adr *AsciidoctorRenderer) RenderValidation(text string) string

type MarkdownRenderer

+ func (m *MarkdownRenderer) RenderDefault(text string) string

v0.1.5

Dec 21, 2023

v0.1.5-1

May 15, 2024

v0.1.4

Dec 13, 2023

v0.1.3

Dec 13, 2023

v0.1.2

Dec 13, 2023

v0.1.1

Dec 13, 2023

Changes in this version

+ type AsciidoctorRenderer struct

+ func NewAsciidoctorRenderer(conf *config.Config) (*AsciidoctorRenderer, error)

+ func (adr *AsciidoctorRenderer) Render(gvd []types.GroupVersionDetails) error

+ func (adr *AsciidoctorRenderer) RenderAnchorID(id string) string

+ func (adr *AsciidoctorRenderer) RenderExternalLink(link, text string) string

+ func (adr *AsciidoctorRenderer) RenderFieldDoc(text string) string

+ func (adr *AsciidoctorRenderer) RenderGVLink(gv types.GroupVersionDetails) string

+ func (adr *AsciidoctorRenderer) RenderLocalLink(prefix, link, text string) string

+ func (adr *AsciidoctorRenderer) RenderType(t *types.Type) string

+ func (adr *AsciidoctorRenderer) RenderTypeLink(t *types.Type) string

+ func (adr *AsciidoctorRenderer) ShouldRenderType(t *types.Type) bool

+ func (adr *AsciidoctorRenderer) ToFuncMap() template.FuncMap

+ func (k AsciidoctorRenderer) IsKubeType(t *types.Type) bool

+ func (k AsciidoctorRenderer) LinkForKubeType(t *types.Type) string

+ type Functions struct

+ func NewFunctions(conf *config.Config) (*Functions, error)

+ func (f *Functions) BasicTypeName(name string) string

+ func (f *Functions) GroupVersionID(gv types.GroupVersionDetails) string

+ func (f *Functions) IsKnownType(t *types.Type) (*config.KnownType, bool)

+ func (f *Functions) LinkForKnownType(kt *config.KnownType) string

+ func (f *Functions) LinkForType(t *types.Type) (link string, local bool)

+ func (f *Functions) SafeID(id string) string

+ func (f *Functions) SimplifiedTypeName(t *types.Type) string

+ func (f *Functions) TypeID(t *types.Type) string

+ func (k Functions) IsKubeType(t *types.Type) bool

+ func (k Functions) LinkForKubeType(t *types.Type) string

+ type MarkdownRenderer struct

+ func NewMarkdownRenderer(conf *config.Config) (*MarkdownRenderer, error)

+ func (k MarkdownRenderer) IsKubeType(t *types.Type) bool

+ func (k MarkdownRenderer) LinkForKubeType(t *types.Type) string

+ func (m *MarkdownRenderer) Render(gvd []types.GroupVersionDetails) error

+ func (m *MarkdownRenderer) RenderExternalLink(link, text string) string

+ func (m *MarkdownRenderer) RenderFieldDoc(text string) string

+ func (m *MarkdownRenderer) RenderGVLink(gv types.GroupVersionDetails) string

+ func (m *MarkdownRenderer) RenderLocalLink(text string) string

+ func (m *MarkdownRenderer) RenderType(t *types.Field) string

+ func (m *MarkdownRenderer) RenderTypeLink(t *types.Type) string

+ func (m *MarkdownRenderer) RenderValidation(f *types.Field) string

+ func (m *MarkdownRenderer) ShouldRenderType(t *types.Type) bool

+ func (m *MarkdownRenderer) ToFuncMap() template.FuncMap

+ type Renderer interface

+ Render func(gvd []types.GroupVersionDetails) error

+ func New(conf *config.Config) (Renderer, error)