Configuration

Configuration is stored in ./configurables/config.json.

Complete Example

{
  "filepath": {
    "sourceMDDir": "./configurables/source_md",
    "destHtmlDir": "./output_html",
    "templatePath": "./configurables/templates",
    "sourceStaticFiles": "./configurables/static",
    "mdAssetsSourcePath": "./configurables/source_md/assets/",
    "mdAssetsDestPath": "./output_html/assets/"
  },
  "indexHomepageHtml": {
    "type": "section",
    "name": "blog"
  },
  "logger": {
    "filepath": "hanamark.logs",
    "level": "debug"
  },
  "rss": {
    "isRssEnabled": true,
    "title": "My Blog",
    "link": "https://example.com",
    "authorName": "Your Name",
    "authorEmailID": "you@example.com",
    "rssOutputName": "feed.xml"
  },
  "site": {
    "title": "My Awesome Blog",
    "description": "A blog about technology and life",
    "url": "https://example.com",
    "image": "/static/images/og-default.png"
  },
  "opengraph": {
    "enabled": true
  },
  "tags": true,
  "sortFilesByCreatedOn": true,
  "servePort": "3000"
}

File Paths

Index Homepage

Controls what content appears on the root index.html:

"indexHomepageHtml": {
  "type": "section",
  "name": "blog",
  "titletag": "My Custom Site Title"
}

Examples

Use blog section as homepage:

"indexHomepageHtml": {
  "type": "section",
  "name": "blog"
}

This configuration:

• Uses list.html template
• Generates blog/index.html with list of all posts
• Copies that as the root index.html

With custom title tag:

"indexHomepageHtml": {
  "type": "section",
  "name": "blog",
  "titletag": "My Awesome Blog - Home"
}

This will use “My Awesome Blog - Home” in the <title> tag of the root index.html instead of the default “blog”

Use about.html as homepage:

"indexHomepageHtml": {
  "type": "page",
  "name": "about.html"
}

Nested Folder Example

source_md/
└── blog/
    ├── _index.md
    ├── post-1.md
    └── tutorials/           # Nested folder
        ├── _index.md
        └── go-basics.md

To use the nested tutorials section as homepage:

// For nested folders, use path from source_md root
"indexHomepageHtml": {
  "type": "section",
  "name": "blog/tutorials"
}

// Or if tutorials is at root level
"indexHomepageHtml": {
  "type": "section",
  "name": "tutorials"
}

How List Pages Work

blog/
├── _index.md      -> Uses list.html   -> blog/index.html (shows links to all posts)
├── post-1.md      -> Uses single.html -> blog/post-1.html
└── post-2.md      -> Uses single.html -> blog/post-2.html

Important: If there is no _index.md in a folder, no list page (index.html) will be generated. The engine will treat files as individual pages only.

Custom Homepage Template

When using type: "section", you can create a custom template for the root index.html by adding _index.html in your templates root directory:

templates/
├── _index.html    # Custom homepage template (optional)
├── _base.html
├── single.html
└── blog/
    └── list.html

• If _index.html exists in templates root, it will be used for the homepage
• If _index.html does not exist, the referenced section’s template (e.g., blog/list.html) will be used

Note: If you have an index.md in your source root, it takes precedence over all these settings.

Site Metadata

Site-level metadata used for SEO, OpenGraph, and other features.

"site": {
  "title": "My Awesome Blog",
  "description": "A blog about technology and life",
  "url": "https://example.com",
  "image": "/static/images/og-default.png"
}

OpenGraph Support (SEO)

Enable OpenGraph and Twitter Card metadata for better social media sharing.

"opengraph": {
  "enabled": true
}

When enabled, generates all necessary meta tags for Facebook, Twitter, and other social platforms. Twitter cards use summary_large_image format by default.

Generated Meta Tags

When enabled, the following meta tags are generated:

<!-- Primary Meta Tags -->
<meta name="title" content="Page Title">
<meta name="description" content="Page or site description">

<!-- Open Graph / Facebook -->
<meta property="og:site_name" content="Site Title">
<meta property="og:title" content="Page Title">
<meta property="og:type" content="article">
<meta property="og:url" content="https://example.com/page.html">
<meta property="og:description" content="Description">
<meta property="og:image" content="https://example.com/image.png">
<link rel="canonical" href="https://example.com/page.html">

<!-- Twitter -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:url" content="https://example.com/page.html">
<meta name="twitter:title" content="Page Title">
<meta name="twitter:description" content="Description">
<meta name="twitter:image" content="https://example.com/image.png">

Page-Level Overrides

Override site defaults using frontmatter:

---
description: "Custom description for this page"
ogImage: "/static/images/custom-og.png"
---

See Front Matter for all available fields

Logger

"logger": {
  "filepath": "hanamark.logs",
  "level": "debug"
}

Other Options