assis

package
v0.0.0-...-5430273 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 15, 2021 License: MIT Imports: 32 Imported by: 0

Documentation

Index

Constants

View Source
const HTML = ".html"
View Source
const MD = ".md"

Variables

This section is empty.

Functions

func CreateTargetFile

func CreateTargetFile(output string) (*os.File, error)

func Exists

func Exists(path string) (bool, error)

func GenerateDir

func GenerateDir(outputFile string) error

Types

type Article

type Article struct {
	ID        string
	Permalink string
	Title     string
	Date      string
	Content   template.HTML
	Preview   template.HTML
	Template  string
	Pin       bool
	Published bool
	Tags      Tags
	Authors   []string
}

type ArticlePlugin

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

func NewArticlePlugin

func NewArticlePlugin(config *Config, logger *zap.Logger) ArticlePlugin

func (ArticlePlugin) OnRegisterCustomFunction

func (m ArticlePlugin) OnRegisterCustomFunction() map[string]interface{}

func (ArticlePlugin) OnRender

func (m ArticlePlugin) OnRender(t AssisTemplate, siteFiles SiteFiles, templates Templates) error

type Assis

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

func NewAssis

func NewAssis(config *Config, plugins []interface{}, logger *zap.Logger) Assis

func (*Assis) Generate

func (a *Assis) Generate() error

func (*Assis) LoadContent

func (a *Assis) LoadContent(path string, d fs.DirEntry, err error) error

func (*Assis) LoadFilesAsync

func (a *Assis) LoadFilesAsync() error

func (*Assis) LoadTemplates

func (a *Assis) LoadTemplates(path string, d fs.DirEntry, err error) error

type AssisTemplate

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

func NewAssisTemplate

func NewAssisTemplate(funcMap template.FuncMap) AssisTemplate

func (AssisTemplate) GetTemplate

func (a AssisTemplate) GetTemplate() *template.Template

type Config

type Config struct {
	SiteRoot string   `json:"site_root"`
	Output   string   `json:"output"`
	Content  string   `json:"content"`
	Template Template `json:"template"`
	Server   Server   `json:"server"`
}

func NewConfigFromFile

func NewConfigFromFile(configPath string) (*Config, error)

func SetDefaultConfigs

func SetDefaultConfigs(config *Config, sitePath string) *Config

type File

type File string

type FileContainer

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

func (*FileContainer) AddOnEntry

func (f *FileContainer) AddOnEntry(file string)

func (*FileContainer) FilterExt

func (f *FileContainer) FilterExt(ext []string) []File

func (*FileContainer) FullFilename

func (f *FileContainer) FullFilename(file File) string

func (*FileContainer) GetFile

func (f *FileContainer) GetFile(filename string) string

func (*FileContainer) OutputFilename

func (f *FileContainer) OutputFilename(file File) string

type Generator

type Generator interface {
	Render(files SiteFiles) error
}

func NewGenerator

func NewGenerator(templates Templates, plugins []interface{}) Generator

type HTMLPlugin

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

func NewHTMLPlugin

func NewHTMLPlugin(config *Config, logger *zap.Logger) HTMLPlugin

func (HTMLPlugin) OnRegisterCustomFunction

func (h HTMLPlugin) OnRegisterCustomFunction() map[string]interface{}

func (HTMLPlugin) OnRender

func (h HTMLPlugin) OnRender(t AssisTemplate, siteFiles SiteFiles, templates Templates) error

func (HTMLPlugin) Truncate

func (h HTMLPlugin) Truncate(size int, str template.HTML) template.HTML

type Linux

type Linux struct{}

func (Linux) ShouldGenerate

func (l Linux) ShouldGenerate(op string) bool

func (Linux) WriteFlags

func (l Linux) WriteFlags() int

type MaCOSX

type MaCOSX struct{}

func (MaCOSX) ShouldGenerate

func (m MaCOSX) ShouldGenerate(op string) bool

func (MaCOSX) WriteFlags

func (m MaCOSX) WriteFlags() int

type MinifyPlugin

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

func NewMinifyPlugin

func NewMinifyPlugin(logger *zap.Logger) MinifyPlugin

func (MinifyPlugin) AfterGeneratedFiles

func (m MinifyPlugin) AfterGeneratedFiles(files []string) error

func (MinifyPlugin) AllowedMediaType

func (m MinifyPlugin) AllowedMediaType(filename string) string

type OS

type OS interface {
	ShouldGenerate(string) bool
	WriteFlags() int
}

func GetOSBySystem

func GetOSBySystem() OS

type PluginCustomFunction

type PluginCustomFunction interface {
	OnRegisterCustomFunction() map[string]interface{}
}

type PluginGeneratedFiles

type PluginGeneratedFiles interface {
	AfterGeneratedFiles([]string) error
}

type PluginLoadFiles

type PluginLoadFiles interface {
	AfterLoadFiles(SiteFiles) error
}

type PluginRender

type PluginRender interface {
	OnRender(AssisTemplate, SiteFiles, Templates) error
}

type Server

type Server struct {
	Port string
}

type SiteFiles

type SiteFiles map[string]*FileContainer

func (SiteFiles) Add

func (s SiteFiles) Add(fc *FileContainer, entry string)

func (SiteFiles) Get

func (s SiteFiles) Get(entry string) *FileContainer

type SiteGenerator

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

func (SiteGenerator) Render

func (h SiteGenerator) Render(siteFiles SiteFiles) error

type StaticFilesPlugin

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

func NewStaticFilesPlugin

func NewStaticFilesPlugin(config *Config, allowedExt []string, logger *zap.Logger) StaticFilesPlugin

func (StaticFilesPlugin) AfterLoadFiles

func (s StaticFilesPlugin) AfterLoadFiles(files SiteFiles) error

type StaticServe

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

func NewStaticServer

func NewStaticServer(config *Config, logger *zap.Logger, listen func() error) StaticServe

func (StaticServe) ListenAndServe

func (s StaticServe) ListenAndServe() error

func (StaticServe) Watch

func (s StaticServe) Watch(os OS) error

type Tags

type Tags []string

type Template

type Template struct {
	Path     string `json:"path"`
	Partials string `json:"partials"`
	Layout   string `json:"layout"`
}

type Templates

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

func NewTemplates

func NewTemplates(config *Config) Templates

func (*Templates) GetTemplatesByDir

func (t *Templates) GetTemplatesByDir(fileToRender string) []string

type Windows

type Windows struct{}

func (Windows) ShouldGenerate

func (w Windows) ShouldGenerate(op string) bool

func (Windows) WriteFlags

func (w Windows) WriteFlags() int

Jump to

Keyboard shortcuts

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