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

org

package

Go to main page

Versions in this module

v1

v1.5.2

Feb 28, 2022

v1.5.1

Jan 24, 2022

Changes in this version

+ func String(nodes []Node) string

+ func WriteNodes(w Writer, nodes ...Node)

+ type Block struct

+ Children []Node

+ Name string

+ Parameters []string

+ Result Node

+ func (b Block) ParameterMap() map[string]string

+ func (n Block) String() string

+ type Column struct

+ Children []Node

+ type ColumnInfo struct

+ Align string

+ DisplayLen int

+ Len int

+ type Comment struct

+ Content string

+ func (n Comment) String() string

+ type Configuration struct

+ AutoLink bool

+ DefaultSettings map[string]string

+ Log *log.Logger

+ MaxEmphasisNewLines int

+ ReadFile func(filename string) ([]byte, error)

+ func New() *Configuration

+ func (c *Configuration) Parse(input io.Reader, path string) (d *Document)

+ func (c *Configuration) Silent() *Configuration

+ type DescriptiveListItem struct

+ Bullet string

+ Details []Node

+ Status string

+ Term []Node

+ func (n DescriptiveListItem) String() string

+ type Document struct

+ BufferSettings map[string]string

+ Error error

+ Links map[string]string

+ Macros map[string]string

+ NamedNodes map[string]Node

+ Nodes []Node

+ Outline Outline

+ Path string

+ func (d *Document) Get(key string) string

+ func (d *Document) GetOption(key string) string

+ func (d *Document) Write(w Writer) (out string, err error)

+ type Drawer struct

+ Children []Node

+ Name string

+ func (n Drawer) String() string

+ type Emphasis struct

+ Content []Node

+ Kind string

+ func (n Emphasis) String() string

+ type Example struct

+ Children []Node

+ func (n Example) String() string

+ type ExplicitLineBreak struct

+ func (n ExplicitLineBreak) String() string

+ type FootnoteDefinition struct

+ Children []Node

+ Inline bool

+ Name string

+ func (n FootnoteDefinition) String() string

+ type FootnoteLink struct

+ Definition *FootnoteDefinition

+ Name string

+ func (n FootnoteLink) String() string

+ type HTMLWriter struct

+ ExtendingWriter Writer

+ HighlightCodeBlock func(source, lang string, inline bool) string

+ PrettyRelativeLinks bool

+ func NewHTMLWriter() *HTMLWriter

+ func (w *HTMLWriter) After(d *Document)

+ func (w *HTMLWriter) Before(d *Document)

+ func (w *HTMLWriter) WriteBlock(b Block)

+ func (w *HTMLWriter) WriteComment(Comment)

+ func (w *HTMLWriter) WriteDescriptiveListItem(di DescriptiveListItem)

+ func (w *HTMLWriter) WriteDrawer(d Drawer)

+ func (w *HTMLWriter) WriteEmphasis(e Emphasis)

+ func (w *HTMLWriter) WriteExample(e Example)

+ func (w *HTMLWriter) WriteExplicitLineBreak(l ExplicitLineBreak)

+ func (w *HTMLWriter) WriteFootnoteDefinition(f FootnoteDefinition)

+ func (w *HTMLWriter) WriteFootnoteLink(l FootnoteLink)

+ func (w *HTMLWriter) WriteFootnotes(d *Document)

+ func (w *HTMLWriter) WriteHeadline(h Headline)

+ func (w *HTMLWriter) WriteHorizontalRule(h HorizontalRule)

+ func (w *HTMLWriter) WriteInclude(i Include)

+ func (w *HTMLWriter) WriteInlineBlock(b InlineBlock)

+ func (w *HTMLWriter) WriteKeyword(k Keyword)

+ func (w *HTMLWriter) WriteLatexFragment(l LatexFragment)

+ func (w *HTMLWriter) WriteLineBreak(l LineBreak)

+ func (w *HTMLWriter) WriteList(l List)

+ func (w *HTMLWriter) WriteListItem(li ListItem)

+ func (w *HTMLWriter) WriteMacro(m Macro)

+ func (w *HTMLWriter) WriteNodeWithMeta(n NodeWithMeta)

+ func (w *HTMLWriter) WriteNodeWithName(n NodeWithName)

+ func (w *HTMLWriter) WriteNodesAsString(nodes ...Node) string

+ func (w *HTMLWriter) WriteOutline(d *Document, maxLvl int)

+ func (w *HTMLWriter) WriteParagraph(p Paragraph)

+ func (w *HTMLWriter) WritePropertyDrawer(PropertyDrawer)

+ func (w *HTMLWriter) WriteRegularLink(l RegularLink)

+ func (w *HTMLWriter) WriteResult(r Result)

+ func (w *HTMLWriter) WriteStatisticToken(s StatisticToken)

+ func (w *HTMLWriter) WriteTable(t Table)

+ func (w *HTMLWriter) WriteText(t Text)

+ func (w *HTMLWriter) WriteTimestamp(t Timestamp)

+ func (w *HTMLWriter) WriterWithExtensions() Writer

+ type Headline struct

+ Children []Node

+ Index int

+ Lvl int

+ Priority string

+ Properties *PropertyDrawer

+ Status string

+ Tags []string

+ TimePlanning Node

+ Title []Node

+ func (h Headline) ID() string

+ func (h Headline) IsExcluded(d *Document) bool

+ func (n Headline) String() string

+ type HorizontalRule struct

+ func (n HorizontalRule) String() string

+ type Include struct

+ Resolve func() Node

+ func (n Include) String() string

+ type InlineBlock struct

+ Children []Node

+ Name string

+ Parameters []string

+ func (n InlineBlock) String() string

+ type Keyword struct

+ Key string

+ Value string

+ func (n Keyword) String() string

+ type LatexFragment struct

+ ClosingPair string

+ Content []Node

+ OpeningPair string

+ func (n LatexFragment) String() string

+ type LineBreak struct

+ BetweenMultibyteCharacters bool

+ Count int

+ func (n LineBreak) String() string

+ type List struct

+ Items []Node

+ Kind string

+ func (n List) String() string

+ type ListItem struct

+ Bullet string

+ Children []Node

+ Status string

+ Value string

+ func (n ListItem) String() string

+ type Macro struct

+ Name string

+ Parameters []string

+ func (n Macro) String() string

+ type Metadata struct

+ Caption [][]Node

+ HTMLAttributes [][]string

+ type Node interface

+ String func() string

+ type NodeWithMeta struct

+ Meta Metadata

+ Node Node

+ func (n NodeWithMeta) String() string

+ type NodeWithName struct

+ Name string

+ Node Node

+ func (n NodeWithName) String() string

+ type OrgWriter struct

+ ExtendingWriter Writer

+ TagsColumn int

+ func NewOrgWriter() *OrgWriter

+ func (w *OrgWriter) After(d *Document)

+ func (w *OrgWriter) Before(d *Document)

+ func (w *OrgWriter) WriteBlock(b Block)

+ func (w *OrgWriter) WriteComment(c Comment)

+ func (w *OrgWriter) WriteDescriptiveListItem(di DescriptiveListItem)

+ func (w *OrgWriter) WriteDrawer(d Drawer)

+ func (w *OrgWriter) WriteEmphasis(e Emphasis)

+ func (w *OrgWriter) WriteExample(e Example)

+ func (w *OrgWriter) WriteExplicitLineBreak(l ExplicitLineBreak)

+ func (w *OrgWriter) WriteFootnoteDefinition(f FootnoteDefinition)

+ func (w *OrgWriter) WriteFootnoteLink(l FootnoteLink)

+ func (w *OrgWriter) WriteHeadline(h Headline)

+ func (w *OrgWriter) WriteHorizontalRule(hr HorizontalRule)

+ func (w *OrgWriter) WriteInclude(i Include)

+ func (w *OrgWriter) WriteInlineBlock(b InlineBlock)

+ func (w *OrgWriter) WriteKeyword(k Keyword)

+ func (w *OrgWriter) WriteLatexFragment(l LatexFragment)

+ func (w *OrgWriter) WriteLineBreak(l LineBreak)

+ func (w *OrgWriter) WriteList(l List)

+ func (w *OrgWriter) WriteListItem(li ListItem)

+ func (w *OrgWriter) WriteMacro(m Macro)

+ func (w *OrgWriter) WriteNodeWithMeta(n NodeWithMeta)

+ func (w *OrgWriter) WriteNodeWithName(n NodeWithName)

+ func (w *OrgWriter) WriteNodesAsString(nodes ...Node) string

+ func (w *OrgWriter) WriteParagraph(p Paragraph)

+ func (w *OrgWriter) WritePropertyDrawer(d PropertyDrawer)

+ func (w *OrgWriter) WriteRegularLink(l RegularLink)

+ func (w *OrgWriter) WriteResult(r Result)

+ func (w *OrgWriter) WriteStatisticToken(s StatisticToken)

+ func (w *OrgWriter) WriteTable(t Table)

+ func (w *OrgWriter) WriteText(t Text)

+ func (w *OrgWriter) WriteTimestamp(t Timestamp)

+ func (w *OrgWriter) WriterWithExtensions() Writer

+ type Outline struct

+ type Paragraph struct

+ Children []Node

+ func (n Paragraph) String() string

+ type Planning struct

+ Deadline Node

+ Schedule Node

+ func (n Planning) String() string

+ type PropertyDrawer struct

+ Properties [][]string

+ func (d *PropertyDrawer) Get(key string) (string, bool)

+ func (n PropertyDrawer) String() string

+ type RegularLink struct

+ AutoLink bool

+ Description []Node

+ Protocol string

+ URL string

+ func (l RegularLink) Kind() string

+ func (n RegularLink) String() string

+ type Result struct

+ Node Node

+ func (n Result) String() string

+ type Row struct

+ Columns []Column

+ IsSpecial bool

+ type Section struct

+ Children []*Section

+ Headline *Headline

+ Parent *Section

+ type StatisticToken struct

+ Content string

+ func (n StatisticToken) String() string

+ type Table struct

+ ColumnInfos []ColumnInfo

+ Rows []Row

+ SeparatorIndices []int

+ func (n Table) String() string

+ type Text struct

+ Content string

+ IsRaw bool

+ func (n Text) String() string

+ type Timestamp struct

+ Interval string

+ IsDate bool

+ RangeTime time.Time

+ Time time.Time

+ Week string

+ func (n Timestamp) String() string

+ type Writer interface

+ After func(*Document)

+ Before func(*Document)

+ String func() string

+ WriteBlock func(Block)

+ WriteComment func(Comment)

+ WriteDescriptiveListItem func(DescriptiveListItem)

+ WriteDrawer func(Drawer)

+ WriteEmphasis func(Emphasis)

+ WriteExample func(Example)

+ WriteExplicitLineBreak func(ExplicitLineBreak)

+ WriteFootnoteDefinition func(FootnoteDefinition)

+ WriteFootnoteLink func(FootnoteLink)

+ WriteHeadline func(Headline)

+ WriteHorizontalRule func(HorizontalRule)

+ WriteInclude func(Include)

+ WriteInlineBlock func(InlineBlock)

+ WriteKeyword func(Keyword)

+ WriteLatexFragment func(LatexFragment)

+ WriteLineBreak func(LineBreak)

+ WriteList func(List)

+ WriteListItem func(ListItem)

+ WriteMacro func(Macro)

+ WriteNodeWithMeta func(NodeWithMeta)

+ WriteNodeWithName func(NodeWithName)

+ WriteNodesAsString func(...Node) string

+ WriteParagraph func(Paragraph)

+ WritePropertyDrawer func(PropertyDrawer)

+ WriteRegularLink func(RegularLink)

+ WriteResult func(Result)

+ WriteStatisticToken func(StatisticToken)

+ WriteTable func(Table)

+ WriteText func(Text)

+ WriteTimestamp func(Timestamp)

+ WriterWithExtensions func() Writer

v1.3.2

Jul 28, 2020

v1.3.1

Jul 22, 2020

v1.3.0

Jun 29, 2020

v1.2.0

Jun 26, 2020

v1.1.0

Apr 17, 2020

v1.0.0

Jan 20, 2020

v0

v0.1.9

Dec 22, 2019

v0.1.8

Nov 2, 2019

v0.1.7

Oct 27, 2019

v0.1.6

Oct 6, 2019

v0.1.5

Sep 28, 2019

v0.1.4

Aug 26, 2019

v0.1.3

Aug 24, 2019

v0.1.2

Jul 28, 2019

v0.1.1

Jul 7, 2019

v0.1.0

Jul 7, 2019

v0.0.1

Jun 4, 2019