Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LoadErrors ¶
type LoadErrors []error
func (*LoadErrors) Error ¶
func (le *LoadErrors) Error() string
type LoadedDocument ¶
type LoadedDocument struct {
Filename string
Document goldast.Node
Source []byte
Goldmark goldmark.Markdown
Context *renderer.Context
}
func (*LoadedDocument) GetInvokes ¶
func (doc *LoadedDocument) GetInvokes() []*ast.InvokeBlock
Walks through the document and returns all the found InvokeBlocks
func (*LoadedDocument) GetSections ¶
func (doc *LoadedDocument) GetSections() []*ast.SectionPointer
Walks through the document and returns all the found SectionPointers
type LoadedDocuments ¶
type LoadedDocuments struct {
MasterDocument *LoadedDocument
ImportedDocuments []*LoadedDocument
Context *renderer.Context
}
func Load ¶
func Load(filename string) (*LoadedDocuments, error)
func LoadString ¶
func LoadString(data string, filename string) (*LoadedDocuments, error)
func (*LoadedDocuments) GetSections ¶
func (doc *LoadedDocuments) GetSections() []*Section
type Section ¶
type Section struct {
Pointer *ast.SectionPointer
Document *LoadedDocument
}
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package renderer renders the given AST to certain formats.
|
Package renderer renders the given AST to certain formats. |
|
glamour
Package renderer renders the given AST to certain formats.
|
Package renderer renders the given AST to certain formats. |
|
styles
The styles here are copied from the awesome Glamour library
|
The styles here are copied from the awesome Glamour library |
|
term/spinner
Package spinner is a simple package to add a spinner / progress indicator to any terminal application.
|
Package spinner is a simple package to add a spinner / progress indicator to any terminal application. |
Click to show internal directories.
Click to hide internal directories.