page

Documentation

Index

• func InsertPage(p *Page)
• type Heading
• type Options
• type Page
  • func NewFromFile(pagePath string, configurationOptions *configuration.Configuration) (page *Page, err error)
  • func (p *Page) CreateFile(configurationOptions *configuration.Configuration, l layout.Layout) error

Functions

func InsertPage

func InsertPage(p *Page)

Types

type Heading

type Heading struct {
	Value    int
	Text     string
	IDLink   string
	Parent   *Heading
	Children []*Heading
}

type Options

type Options struct {
	Abstract    string   `yaml:"abstract"`
	AuthorList  []string `yaml:"authorList"`
	Layout      string   `yaml:"layout"`
	PublishDate string   `yaml:"publishDate"`
	LastUpdated string   `yaml:"lastUpdated"`
	Tags        []string `yaml:"tags"`
	Title       string   `yaml:"title"`

	Authors []configuration.Author
}

type Page

type Page struct {
	Options  Options                      `handlebars:"document"`
	Content  string                       `handlebars:"content"`
	Headings []*Heading                   `handlebars:"headings"`
	Global   *configuration.Configuration `handlebars:"global"`
	Pages    []*Page                      `handlebars:"pages"`

	RelativePath string
	// contains filtered or unexported fields
}

func NewFromFile

func NewFromFile(pagePath string, configurationOptions *configuration.Configuration) (page *Page, err error)

func (*Page) CreateFile

func (p *Page) CreateFile(configurationOptions *configuration.Configuration, l layout.Layout) error