page

Documentation

Overview

Package page 定义 html 页面需要的内容

Index

• type Page
  • func (p *Page) Next(url, text string)
  • func (p *Page) Prev(url, text string)
  • func (p *Page) Render(name string)
• type Site
  • func NewSite(d *data.Data) *Site
  • func (site *Site) Page(ctx *context.Context, typ string, d *data.Data) *Page

Types

type Page

type Page struct {
	Site *Site

	Title       string       // 文章标题
	Subtitle    string       // 副标题
	Canonical   string       // 当前页的唯一链接
	Keywords    string       // meta.keywords 的值
	Description string       // meta.description 的值
	PrevPage    *data.Link   // 前一页
	NextPage    *data.Link   // 下一页
	Type        string       // 当前页面类型
	Charset     string       // 当前页的字符集
	Author      *data.Author // 作者
	License     *data.Link   // 当前页的版本信息，可以为空

	// 以下内容，仅在对应的页面才会有内容
	Q        string          // 搜索关键字
	Tag      *data.Tag       // 标签详细页面，非标签详细页，则为空
	Posts    []*data.Post    // 文章列表，仅标签详情页和搜索页用到。
	Post     *data.Post      // 文章详细内容，仅文章页面用到。
	Archives []*data.Archive // 归档
	// contains filtered or unexported fields
}

Page 用于描述一个页面的所有无素

func (*Page) Next

func (p *Page) Next(url, text string)

Next 产生 NextPage 内容

func (*Page) Prev

func (p *Page) Prev(url, text string)

Prev 产生 PrevPage 内容

func (*Page) Render

func (p *Page) Render(name string)

Render 渲染内容

type Site

type Site struct {
	AppName    string // 程序名称
	AppURL     string // 程序官网
	AppVersion string // 当前程序的版本号
	GoVersion  string // 编译的 Go 版本号
	Theme      *data.Theme

	SiteName      string     // 网站名称
	Subtitle      string     // 网站副标题
	URL           string     // 网站地址，若是一个子目录，则需要包含该子目录
	Icon          *data.Icon // 网站图标
	Language      string     // 页面语言
	PostSize      int        // 总文章数量
	Beian         string     // 备案号
	Uptime        time.Time  // 上线时间
	LastUpdated   time.Time  // 最后更新时间
	RSS           *data.Link // RSS，NOTICE:指针方便模板判断其值是否为空
	Atom          *data.Link
	Opensearch    *data.Link
	Manifest      *data.Link
	ServiceWorker string       // 指向 service worker 的 js 文件
	Tags          []*data.Tag  // 标签列表
	Series        []*data.Tag  // 专题列表
	Links         []*data.Link // 友情链接
	Menus         []*data.Link // 导航菜单
}

Site 页面的附加信息，除非重新加载数据，否则内容不会变。

func NewSite

func NewSite(d *data.Data) *Site

NewSite 声明 Site 实例

func (*Site) Page

func (site *Site) Page(ctx *context.Context, typ string, d *data.Data) *Page

Page 生成 Page 实例