Documentation

How to create a theme

Fixed directory names

Directory Name
layouts All the layouts (can be nested)
static All content inside static directory will be copied in the build directory

If the user defines some layout or content inside static directory and if the name collides with theme layout or static content, then in this case uses's layout or content will override the theme's layout or static content file

Fixed layout names

Template name
post.html Main content of the blog
page.html Page content of the blog
category.html Individual Category page
tag.html Individual Tag page
author.html Individual Author page
latest-posts.html Latest posts listing

Blog Default Configuration

Description Key Name Values
Base Url baseUrl /
Website Title title My Site
Website description description This is a description
Posts Directory postsDir posts
Pages Directory pagesDir pages
Generated Html Pages Directory generatedHtmlDir dist
Temporary Directory tempDir temp
Static Content Directory staticContentDir static
Data Directory dataDir data
Themes Directory themesDir themes
Category Base Url categoryBase /topics
Tag Base Url tagBase /tag
Author Base authorBase /author
Latest Posts Base latestPostsBase /
Post permalink postPermalink /:slug.html
Post Ugly Url Enabled postUglyUrlEnabled true
Page permalink pagePermalink /:slug
Page Ugly Url Enabled pageUglyUrlEnabled false
Default Category category others
Pagination Enabled paginationEnabled true
Maximum Posts maxPosts 10
Post Writing Date Format postWritingDataFormat yyyy-MM-dd'T'HH:mm:ssXXX
Theme to apply theme Need to set manually / Github url can also be provided
Default Author name in posts author Need to set manually