๐Ÿบ Freki

ยง Megane @~@

Megane (็œผ้ก) is the Japanese word for ๐Ÿ‘“ glasses, a macOS game (Yuichi Fujishige), and it's also this silly templating mini-engine.

ยง Freki HTML Template

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    @~@FRONTMATTER:DESCRIPTION@~@
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    @~@FRONTMATTER:TITLE@~@
    <link rel="stylesheet" href="/styles.css">
  </head>

  <body>
    @~@FREKI:SITE_JSON@~@
    <header>
      <h1>
        <a href="/">๐Ÿ‘“ @~@FREKI:SITE_TITLE@~@</a>
      </h1>
    </header>

    @~@FREKI:NAVIGATION@~@

    <main>
      @~@FREKI:MARKDOWN_CONTENT@~@
    </main>
  </body>
</html>

ยง Syntax

ยง Tags

name type

@~@FREKI:MARKDOWN_CONTENT@~@

HTML

@~@FREKI:SITE_TITLE@~@

TEXT

@~@FREKI:TITLE@~@

HTML

@~@FREKI:DESCRIPTION@~@

HTML

@~@FREKI:CURRENT_PATH@~@

TEXT

@~@FREKI:NAVIGATION@~@

HTML

@~@FREKI:NAVIGATION_FOOTER@~@

HTML

@~@FREKI:BASE_URL@~@

PATH

@~@FREKI:SITE_JSON@~@

HTML

ยง @~@FREKI:MARKDOWN_CONTENT@~@

The generated HTML content from the markdown file.

<section id="markdown">
  <!-- content -->
</section>

ยง @~@FREKI:SITE_TITLE@~@

The site_title defaults to Freki cause why not.

ยง @~@FREKI:TITLE@~@

<title>frontmatter_page_title | freki_site_title</title>

<!-- if no page title -->
<title>freki_site_title</title>

ยง @~@FREKI:DESCRIPTION@~@

<meta name="description" content="frontmatter_description">

ยง @~@FREKI:CURRENT_PATH@~@

The path (/the/current/path/) to the current page.

ยง @~@FREKI:NAVIGATION@~@

<!-- Inline cSS... -->
<aside id="freki-floating-menu">
  <!-- menu button... -->
  <nav id="sidebar-menu">
    <ul>
      <li><a href="/path/">page_title</a></li>
      <li><a href="/path/">page_title</a></li>
    </ul>
  </nav>
</aside>

<!-- Inline cSS... -->
<footer id="freki-navigation-footer">
  <a href="/next/path/" style="margin-left: auto"><button>Next</button></a>
  <a href="/previous/path/" style="margin-right: auto"><button>
      Previous
    </button></a>
</footer>

ยง @~@FREKI:BASE_URL@~@

Required if the docs are hosted in sub path of the main host like GitHub or Codeberg pages. It will transform src and href attributes: /some/path/ to /base-url-value/some/path.

ยง @~@FREKI:SITE_JSON@~@

Includes page site data as a jSON script element. Useful for scripting.

Example 
<script id="freki-site-data" type="application/json">
{
  "path": "main",
  "order": 0,
  "pages": [
    {
      "name": "megane.md",
      "path": "/megane/",
      "frontmatter": {
        "title": "Megane",
        "description": "The silliest templating engine",
        "updated": "2026-06-28",
        "published": "2026-06-28",
        "order": 2,
        "flavor": 3,
        "excludeFromFrekiNavigation": false
      },
      "order": 2
    }
  ],
  "paths": [
    {
      "path": "markdown",
      "order": 1,
      "pages": [
        {
          "name": "extended.md",
          "path": "/markdown/extended/",
          "frontmatter": {
            "title": "Extended Syntax",
            "description": "Extended markdown syntax.",
            "updated": "2024-11-28",
            "published": "2024-10-25",
            "order": 1,
            "flavor": 2,
            "excludeFromFrekiNavigation": false
          },
          "order": 1
        }
      ],
      "paths": [
        {
          "path": "extended",
          "order": 0,
          "pages": [
            {
              "name": "task-list.md",
              "path": "/markdown/extended/task-list/",
              "frontmatter": {
                "title": "Task List",
                "description": "Extended markdown syntax.",
                "created": "2026-07-13",
                "updated": "2026-07-13",
                "order": 1,
                "flavor": 2,
                "excludeFromFrekiNavigation": false
              },
              "order": 1
            }
          ],
          "paths": []
        }
      ]
    }
  ]
}
</script>

ยง Page Frontmatter Data Tags

These tags extract data provide in the markdown frontmatter.

{
  "title": "Basic Syntax",
  "description": "Basic markdown syntax.",
  "created": "2024-10-24",
  "updated": "2024-11-06",
  "published": "2024-11-06"
}
name type description

@~@FRONTMATTER:TITLE@~@

TEXT

Page title

@~@FRONTMATTER:DESCRIPTION@~@

TEXT

Page description

@~@FRONTMATTER:CREATED@~@

TEXT

Page creation date

@~@FRONTMATTER:UPDATE@~@

TEXT

Date the page was last updated the page was last updated

@~@FRONTMATTER:PUBLISHED@~@

TEXT

Date the page was first published