server

Documentation

Index

• Constants
• Variables
• func CopyDirectory(source, dest string) error
• func CopyFile(source, dest string)
• func CreateNewMarkdownFile(title string, path string)
• type BlogMetadata
• type BlogOption
  • func RenderUnpublished() BlogOption
• type BlogPost
  • func (post *BlogPost) FormatDate() string
• type BlogPostTemplateArgs
• type BlogRenderCache
  • func NewBlogRenderer(prefix string, outputPath string, filename string, opts ...BlogOption) *BlogRenderCache
  • func (b *BlogRenderCache) Render()
• type BlogTemplateArgs
• type ExternalPostsMetadata
  • func (epm ExternalPostsMetadata) FormatDate() string
• type LinkMetadata
  • func NewLinks() LinkMetadata
• type MarkdownRenderer
  • func NewMarkdownRenderer() MarkdownRenderer
  • func (mr *MarkdownRenderer) Render(filepath string) (map[string]interface{}, string)
• type ProfileMetadata
  • func (pm ProfileMetadata) SVGSource() string
• type SiteBuilder
  • func NewSiteBuilder(inputPath string, outputPath string) *SiteBuilder
  • func (b SiteBuilder) Build()
  • func (b *SiteBuilder) WithBlogOptions(opts []BlogOption) *SiteBuilder
• type TemplateRenderer
  • func NewTemplateRenderer(base string) *TemplateRenderer
  • func (t *TemplateRenderer) AddTemplate(paths ...string)
  • func (t *TemplateRenderer) Render(out io.Writer, path string, data any)

Constants

const BASE_TEMPLATE = "/templates/base.tmpl"

const BLOG_BASE_PATH = "blog"

const BLOG_PAGE_TEMPLATE = "/templates/blog.tmpl"

const BLOG_POST_TEMPLATE = "/templates/blog_post.tmpl"

Variables

var LINKS_PATH = "config/links.yml"

Functions

func CopyDirectory

func CopyDirectory(source, dest string) error

func CopyFile

func CopyFile(source, dest string)

func CreateNewMarkdownFile

func CreateNewMarkdownFile(title string, path string)

Types

type BlogMetadata

type BlogMetadata struct {
	Title       string    `yaml:"title"`
	IsPublished bool      `yaml:"published"`
	Date        time.Time `yaml:"date"`
	Slug        string    `yaml:"slug"`
	Tags        []string  `yaml:"tags"`
}

type BlogOption

type BlogOption func(*BlogRenderCache)

func RenderUnpublished

func RenderUnpublished() BlogOption

type BlogPost

type BlogPost struct {
	Slug     string
	Path     string
	Body     string
	Metadata BlogMetadata
}

func (*BlogPost) FormatDate

func (post *BlogPost) FormatDate() string

type BlogPostTemplateArgs

type BlogPostTemplateArgs struct {
	Title string
	Body  string
	Links LinkMetadata
}

type BlogRenderCache

type BlogRenderCache struct {
	Prefix                string
	OutputPath            string
	Items                 []BlogPost
	ShouldListUnpublished bool
	Links                 LinkMetadata
	// contains filtered or unexported fields
}

func NewBlogRenderer

func NewBlogRenderer(prefix string, outputPath string, filename string, opts ...BlogOption) *BlogRenderCache

func (*BlogRenderCache) Render

func (b *BlogRenderCache) Render()

type BlogTemplateArgs

type BlogTemplateArgs struct {
	Title     string
	Body      string
	BlogItems []BlogPost
	Links     LinkMetadata
}

type ExternalPostsMetadata

type ExternalPostsMetadata struct {
	Title string    `yaml:"title"`
	Link  string    `yaml:"link"`
	Date  time.Time `yaml:"date"`
}

func (ExternalPostsMetadata) FormatDate

func (epm ExternalPostsMetadata) FormatDate() string

type LinkMetadata

type LinkMetadata struct {
	Profiles []ProfileMetadata       `yaml:"profiles"`
	External []ExternalPostsMetadata `yaml:"external_posts"`
}

func NewLinks

func NewLinks() LinkMetadata

type MarkdownRenderer

type MarkdownRenderer struct {
	// contains filtered or unexported fields
}

func NewMarkdownRenderer

func NewMarkdownRenderer() MarkdownRenderer

func (*MarkdownRenderer) Render

func (mr *MarkdownRenderer) Render(filepath string) (map[string]interface{}, string)

type ProfileMetadata

type ProfileMetadata struct {
	Title string `yaml:"title"`
	Link  string `yaml:"link"`
}

func (ProfileMetadata) SVGSource

func (pm ProfileMetadata) SVGSource() string

type SiteBuilder

type SiteBuilder struct {
	InputPath   string
	OutputPath  string
	BlogOptions []BlogOption
}

func NewSiteBuilder

func NewSiteBuilder(inputPath string, outputPath string) *SiteBuilder

func (SiteBuilder) Build

func (b SiteBuilder) Build()

func (*SiteBuilder) WithBlogOptions

func (b *SiteBuilder) WithBlogOptions(opts []BlogOption) *SiteBuilder

type TemplateRenderer

type TemplateRenderer struct {
	// contains filtered or unexported fields
}

func NewTemplateRenderer

func NewTemplateRenderer(base string) *TemplateRenderer

func (*TemplateRenderer) AddTemplate

func (t *TemplateRenderer) AddTemplate(paths ...string)

func (*TemplateRenderer) Render

func (t *TemplateRenderer) Render(out io.Writer, path string, data any)