Documentation ¶
Index ¶
- type BuildConfig
- type DirConfig
- type Extension
- type ExtensionConfig
- type MiddlewareConfig
- type Project
- type ProjectConfig
- type ProjectOption
- type ProjectOptionFunc
- func WithConfig(config *ProjectConfig) ProjectOptionFunc
- func WithExtensions(extensions ...Extension) ProjectOptionFunc
- func WithParserOptions(opts ...parser.ParserOption) ProjectOptionFunc
- func WithRendererOptions(opts ...renderer.RendererOption) ProjectOptionFunc
- func WithWorkDir(dir string) ProjectOptionFunc
- type SiteConfig
- type ThemeConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildConfig ¶
type BuildConfig struct {
Dir string `yaml:"dir"`
}
func (*BuildConfig) GetDir ¶
func (c *BuildConfig) GetDir() string
type ExtensionConfig ¶
func (*ExtensionConfig) UnmarshalYAML ¶
func (ex *ExtensionConfig) UnmarshalYAML(value *yaml.Node) error
type MiddlewareConfig ¶
type Project ¶
type Project struct {
// contains filtered or unexported fields
}
func New ¶
func New(opts ...ProjectOption) *Project
type ProjectConfig ¶
type ProjectConfig struct { Name string `yaml:"name"` Site SiteConfig `yaml:"site"` Theme ThemeConfig `yaml:"theme"` Build BuildConfig `yaml:"build"` Uses []ExtensionConfig `yaml:"uses"` }
func LoadConfigFile ¶
func LoadConfigFile(projectFS afero.Fs) (*ProjectConfig, error)
type ProjectOption ¶
type ProjectOptionFunc ¶
func WithConfig ¶
func WithConfig(config *ProjectConfig) ProjectOptionFunc
func WithExtensions ¶
func WithExtensions(extensions ...Extension) ProjectOptionFunc
func WithParserOptions ¶
func WithParserOptions(opts ...parser.ParserOption) ProjectOptionFunc
func WithRendererOptions ¶
func WithRendererOptions(opts ...renderer.RendererOption) ProjectOptionFunc
func WithWorkDir ¶
func WithWorkDir(dir string) ProjectOptionFunc
func (ProjectOptionFunc) Apply ¶
func (apply ProjectOptionFunc) Apply(p *Project) error
type SiteConfig ¶
type SiteConfig struct {
Dir string `yaml:"dir"`
}
func (*SiteConfig) GetDir ¶
func (c *SiteConfig) GetDir() string
type ThemeConfig ¶
type ThemeConfig struct {
Dir string `yaml:"dir"`
}
func (*ThemeConfig) GetDir ¶
func (c *ThemeConfig) GetDir() string
Click to show internal directories.
Click to hide internal directories.