docstring

Documentation

Overview

Package docstring provides the standard docstring Markdown for the system's built-in forms.

Index

• Constants
• func Exists(n string) bool
• func Get(n string) string
• func ParseMarkdown(doc string) (data.Object, []string)

Constants

const (
	DocNotFound = "could not find doc: %s"
)

Error messages

Functions

func Exists

func Exists(n string) bool

Exists returns whether or not a specific docstring exists

func Get

func Get(n string) string

Get resolves documentation using snapshot assets

func ParseMarkdown

func ParseMarkdown(doc string) (data.Object, []string)

ParseMarkdown parses the kind of markdown document that might be processed by a static site generator. It will parse any prologue parameters into the resulting object and return the remaining content as individual lines