blog

package

v1.3.3 Latest Latest Go to latest Published: Apr 7, 2020 License: MIT Imports: 22 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/andrewpillar/jrnl

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Slug(s string) string
type Category
- func Categories() ([]Category, error)
- func GetCategory(id string) (Category, error)
- func (c Category) Href() string
type Feed
- func GetRoll(urls ...string) ([]Feed, error)
- func (f Feed) Write(w io.Writer, kind string, pp []Post) error
type Index
- func NewIndex() Index
- func (i *Index) Put(p Post)
- func (i Index) Write(key string, s Site) (string, error)
type Page
- func GetPage(id string) (Page, error)
- func NewPage(title string) Page
- func Pages() ([]Page, error)
- func (p Page) Hash() []byte
- func (p Page) Href() string
- func (p *Page) Load() error
- func (p *Page) Remove() error
- func (p *Page) Render()
- func (p Page) Save() error
- func (p *Page) Touch() error
type Post
- func GetPost(id string) (Post, error)
- func NewPost(title, category string) Post
- func Posts() ([]Post, error)
- func (p Post) HasCategory() bool
- func (p *Post) Load() error
- func (p *Post) Remove() error
- func (p *Post) Render()
- func (p Post) Save() error
- func (p *Post) Touch() error
type Site
type Theme
- func GetTheme(name string) (Theme, error)
- func NewTheme(name string) Theme
- func Themes() ([]Theme, error)
- func (t Theme) Load() error
- func (t *Theme) Remove() error
- func (t Theme) Save() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNoLayout = errors.New("no layout")
)

Functions ¶

func Slug ¶

func Slug(s string) string

Types ¶

type Category ¶

type Category struct {
	ID         string
	Name       string
	Categories []Category
}

func Categories ¶

func Categories() ([]Category, error)

func GetCategory ¶

func GetCategory(id string) (Category, error)

func (Category) Href ¶

func (c Category) Href() string

type Feed ¶

type Feed struct {
	Title       string
	Link        string
	Description string
	Author      feeds.Author
}

func GetRoll ¶

func GetRoll(urls ...string) ([]Feed, error)

func (Feed) Write ¶

func (f Feed) Write(w io.Writer, kind string, pp []Post) error

type Index ¶

type Index map[string][]Post

func NewIndex ¶

func NewIndex() Index

func (*Index) Put ¶

func (i *Index) Put(p Post)

func (Index) Write ¶

func (i Index) Write(key string, s Site) (string, error)

type Page ¶

type Page struct {
	ID         string
	Title      string
	Layout     string
	SourcePath string
	SitePath   string
	Body       string
	Delete     bool
}

func GetPage ¶

func GetPage(id string) (Page, error)

func NewPage ¶

func NewPage(title string) Page

func Pages ¶

func Pages() ([]Page, error)

func (Page) Hash ¶

func (p Page) Hash() []byte

func (Page) Href ¶

func (p Page) Href() string

func (*Page) Load ¶

func (p *Page) Load() error

func (*Page) Remove ¶

func (p *Page) Remove() error

func (*Page) Render ¶

func (p *Page) Render()

func (Page) Save ¶

func (p Page) Save() error

func (*Page) Touch ¶

func (p *Page) Touch() error

type Post ¶

type Post struct {
	Page

	Index       bool
	Description string
	Category    Category
	CreatedAt   postTime
	UpdatedAt   postTime
}

func GetPost ¶

func GetPost(id string) (Post, error)

func NewPost ¶

func NewPost(title, category string) Post

func Posts ¶

func Posts() ([]Post, error)

func (Post) HasCategory ¶

func (p Post) HasCategory() bool

func (*Post) Load ¶

func (p *Post) Load() error

func (*Post) Remove ¶

func (p *Post) Remove() error

func (*Post) Render ¶ added in v1.3.0

func (p *Post) Render()

func (Post) Save ¶

func (p Post) Save() error

func (*Post) Touch ¶

func (p *Post) Touch() error

type Site ¶

type Site struct {
	Title      string
	Link       string
	Categories []Category
	Pages      []Page
	Blogroll   []Feed
}

type Theme ¶

type Theme struct {
	Name string
	Path string
}

func GetTheme ¶

func GetTheme(name string) (Theme, error)

func NewTheme ¶

func NewTheme(name string) Theme

func Themes ¶

func Themes() ([]Theme, error)

func (Theme) Load ¶

func (t Theme) Load() error

func (*Theme) Remove ¶

func (t *Theme) Remove() error

func (Theme) Save ¶

func (t Theme) Save() error

Source Files ¶

View all Source files

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