package
0.2.24
Repository: https://github.com/cooper/quiki.git
Documentation: pkg.go.dev

# Functions

CategoryName returns a clean category name.
CategoryNameNE returns a clean category with No Extension.
InjectPageOpt extracts page options found in the specified page and injects them into the provided PageOpt pointer.
MakeDir creates directories recursively.
ModelName returns a clean model name.
NewList creates a new list, given the main block of the page it is to be associated with.
NewMap creates a new map, given the main block of the page it is to be associated with.
NewPage creates a page given its filepath.
NewPagePath creates a page given its filepath and relative name.
NewPageSource creates a page given some source code.
PageName returns a clean page name.
PageNameExt returns a clean page name with the provided extension.
PageNameLink returns a clean page name without the extension.
PageNameNE returns a clean page name with No Extension.
ScaleString returns a string of scaled image names for use in srcset.
UniqueFilesInDir recursively scans a directory for files matching the requested extensions, resolves symlinks, and returns a list of unique files.

# Constants

PageOptExternalTypeMediaWiki is the external type for MediaWiki sites.
PageOptExternalTypeNone is an external type that can be used for websites that perform no normalization of page targets beyond normal URI escaping.
PageOptExternalTypeQuiki is the external type for quiki sites.

# Structs

FmtOpt describes options for page.FmtOpts.
List represents a list of items.
Map represents a Key-value dictionary.
ModelInfo represents metadata associated with a model.
Page represents a single page or article, generally associated with a .page file.
PageInfo represents metadata associated with a page.
PageOpt describes wiki/website options to a Page.
PageOptCategory describes wiki category options.
PageOptCode describes options for `code{}` blocks.
PageOptDir describes actual filepaths to wiki resources.
PageOptExternal describes an external wiki that we can use for link targets.
PageOptHost describes HTTP hosts for a wiki.
PageOptImage describes wiki imaging options.
PageOptLink describes functions to assist with link targets.
PageOptLinkOpts contains options passed to a PageOptLinkFunction.
PageOptNavigation represents an ordered navigation item.
PageOptPage describes option relating to a page.
PageOptRoot describes HTTP paths to wiki resources.
PageOptSearch describes wiki search options.
ParserError represents an error in parsing with positional info.
Position represents a line and column position within a quiki source file.
Warning represents a warning on a page.

# Interfaces

An AttributedObject is any object on which you can set and retrieve attributes.

# Type aliases

HTML encapsulates a string to indicate that it is preformatted HTML.
PageOptExternalType describes.
A PageOptLinkFunction sanitizes a link target.