daybookr

package

v0.0.0-...-1298ecb Latest Latest Go to latest Published: Apr 26, 2020 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/figglewatts/daybookr

Documentation ¶

Index ¶

Constants
func From(start int, s []string) []string
func FromTo(start int, end int, s []string) []string
func Generate(inputFolder string, outputFolder string, configPath string) error
func IsSite(data interface{}) bool
func LoadText(filename string) (string, error)
func PostsByYear(site Site) []yearPosts
func To(end int, s []string) []string
type Content
type Link
- func CreateLink(text string, target string) (Link, error)
- func CreateLinkFromYAML(yaml *simpleyaml.Yaml) (Link, error)
type Page
- func (page Page) GetHTMLPreview(chars int) string
type Post
type Site
- func (site Site) PostsTo(count int) []Post

Constants ¶

View Source

const (
	LinkYAMLTextField   = "text"
	LinkYAMLTargetField = "target"
)

Variables ¶

This section is empty.

Functions ¶

func From ¶

func From(start int, s []string) []string

func FromTo ¶

func FromTo(start int, end int, s []string) []string

func Generate ¶

func Generate(inputFolder string, outputFolder string, configPath string) error

func IsSite ¶

func IsSite(data interface{}) bool

func LoadText ¶

func LoadText(filename string) (string, error)

func PostsByYear ¶

func PostsByYear(site Site) []yearPosts

func To ¶

func To(end int, s []string) []string

Types ¶

type Content ¶

type Content struct {
	Site Site
	HTML string
}

type Link ¶

type Link struct {
	Text   string
	Target *url.URL
}

func CreateLink ¶

func CreateLink(text string, target string) (Link, error)

func CreateLinkFromYAML ¶

func CreateLinkFromYAML(yaml *simpleyaml.Yaml) (Link, error)

type Page ¶

type Page struct {
	Layout     string
	Metadata   *simpleyaml.Yaml
	RawContent string
	Content    string
	Name       string
	Title      string
	Site       *Site
}

func (Page) GetHTMLPreview ¶

func (page Page) GetHTMLPreview(chars int) string

type Post ¶

type Post struct {
	Page
	Tags []string
	Date time.Time
}

type Site ¶

type Site struct {
	Title          string
	Subtitle       string
	Author         string
	Pages          []Page
	Posts          []Post
	Tags           []tag
	FooterLinks    []Link
	Conf           *simpleyaml.Yaml
	GenerationTime time.Time
}

func (Site) PostsTo ¶

func (site Site) PostsTo(count int) []Post

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL