repo

Documentation

Index

• func WriteArticle(libraryPath, templatePath string, article Article) (err error)
• type Article
  • func ParseArticle(libraryPath, containerName string) (result Article, err error)
  • func (a *Article) AddDescription(new string)
  • func (a *Article) AddName(name string)
  • func (a *Article) AddVersion(new string)
  • func (a *Article) SetDate(new time.Time)
  • func (a *Article) SetSize(new string)

Functions

func WriteArticle

func WriteArticle(libraryPath, templatePath string, article Article) (err error)

Types

type Article

type Article struct {
	Layout       string    `yaml:"layout"`
	Name         string    `yaml:"name"`
	GitHub       string    `yaml:"github"`
	Versions     []string  `yaml:"versions"`
	Date         time.Time `yaml:"updated_at"`
	Size         string    `yaml:"size"`
	Description  string    `yaml:"description"`
	ContainerURL string    `yaml:"container_url"`
}

func ParseArticle

func ParseArticle(libraryPath, containerName string) (result Article, err error)

func (*Article) AddDescription

func (a *Article) AddDescription(new string)

AddDescription adds a description to a an article

func (*Article) AddName

func (a *Article) AddName(name string)

AddName sets the name of an article

func (*Article) AddVersion

func (a *Article) AddVersion(new string)

AddVersion adds a version to the article metadata

func (*Article) SetDate

func (a *Article) SetDate(new time.Time)

SetDate sets the published date for an article

func (*Article) SetSize

func (a *Article) SetSize(new string)

SetSize adds/updates the size of a container to a an article