Safe Haskell	None
Language	GHC2024

MathiasSM.Config

Contents

Hakyll's Configuration
Deployment config
Files
Patterns for files
Directories
Identifiers
- Templates
- Data files

Description

Site-wide configuration: identity, where content lives, what groups exist, shared templates

Synopsis

siteConfiguration :: Configuration
data SiteConfig = SiteConfig {
- siteName :: String
- siteDescription :: String
- siteAuthor :: String
- siteCopyrightYear :: Int
- siteDomain :: String
- twitterHandle :: String
- mathjaxVersion :: String
- highlightStyle :: HighlightStyle
- contentDir :: FilePath
- assetsDir :: FilePath
- templatesDir :: FilePath
- contentTemplatesDir :: FilePath
- contentCssDir :: FilePath
- contentTemplateNames :: [FilePath]
- siteEnv :: Env
}
data Env
- = Dev
- | Prod
baseUrl :: SiteConfig -> String
requiredContent :: SiteConfig -> [FilePath]
mediaDir :: SiteConfig -> FilePath
projectsGroup :: String
postSnapshot :: String -> Snapshot
writingsPattern :: SiteConfig -> Pattern
pagesPattern :: SiteConfig -> String -> Pattern
postsPattern :: SiteConfig -> String -> Pattern
projectsPattern :: SiteConfig -> Pattern
socialsPattern :: SiteConfig -> Pattern
dataPattern :: SiteConfig -> Pattern
dataSchemaPattern :: SiteConfig -> Pattern
templatePattern :: SiteConfig -> Pattern
contentCssPattern :: SiteConfig -> Pattern
dataDir :: SiteConfig -> FilePath
siteTemplate :: SiteConfig -> Identifier
minimalTemplate :: SiteConfig -> Identifier
pageTemplate :: SiteConfig -> Identifier
postTemplate :: SiteConfig -> Identifier
resolveTemplate :: SiteConfig -> FilePath -> Identifier
socialsFile :: SiteConfig -> Identifier

Hakyll's `Configuration`

siteConfiguration :: Configuration Source #

Hakyll's default configuration, except that `.well-known` folders are not ignored (Hakyll skips every dot-folder, but `assetsstatic.well-known/` must be published) TODO: Review if condition is correct, or even needed

Deployment config

data SiteConfig Source #

Build-time site configuration, gathered once from the environment by MathiasSM.Cli. Every field maps to an environment variable; see .env.example

Constructors

SiteConfig

Fields

siteName :: String
Site name, exposed to templates as site-name
siteDescription :: String
Site tagline, exposed as site-description
siteAuthor :: String
Site author, exposed as site-author
siteCopyrightYear :: Int
Copyright year, exposed as site-copyrightYear
siteDomain :: String
Domain without scheme, exposed as site-domain
twitterHandle :: String
Twitter (X) handle (without @), used for the social cards of posts
mathjaxVersion :: String
MathJax CDN version (from mathjax: in website.yaml), exposed as mathjax-version
I might some day decide not to use the CDN and rather vend the bundle.
highlightStyle :: HighlightStyle
Pandoc syntax-highlighting style (from highlight.style in website.yaml), driving the generated CSS
contentDir :: FilePath
Where the actual content lives
assetsDir :: FilePath
Where the assests live (assets by default)
templatesDir :: FilePath
Where the templates live (templates by default)
contentTemplatesDir :: FilePath
Content-provided templates (contenttemplates), overriding the vendored set file by file
contentCssDir :: FilePath
Content-provided styles (contentcss), loaded after the vendored styles
contentTemplateNames :: [FilePath]
The template names (relative to contentTemplatesDir) the content provides
siteEnv :: Env
Whether this is a dev build (which publishes example preview pages)

data Env Source #

The build environment: Dev also publishes the preview pages under example

Constructors

Dev
Prod

Instances

Instances details

Show Env Source #
Instance details Defined in MathiasSM.Config Methods showsPrec :: Int -> Env -> ShowS # show :: Env -> String # showList :: [Env] -> ShowS #
Eq Env Source #
Instance details Defined in MathiasSM.Config Methods (==) :: Env -> Env -> Bool # (/=) :: Env -> Env -> Bool #