InkStone

Branding

Contents

InkStone ships with its own logo and favicon. All three branding elements — the favicon, the icon beside the site title, and the displayed title itself — can be overridden from your vault with no code changes.


Favicon

InkStone serves its built-in logo at /favicon.ico, /favicon.png, and /favicon.svg by default.

To use your own favicon, place a file named favicon.ico, favicon.png, or favicon.svg in the root of your vault. InkStone checks for it on every request and serves it in place of the default. The first match wins in this order: .ico.png.svg.

your-vault/
  favicon.ico   ← drop it here to override
  homepage.md
  blog/
  ...

No config, no restart needed — the hot-reload file watcher picks it up automatically.


Site icon (beside the title)

Add an icon: field to any note's frontmatter to show an image beside the site title in the header.

---
website: true
type: homepage
title: My Site
icon: _attachments/my-logo.png
---

Path formats

Value How it's served
_attachments/logo.png Vault-relative — served via /attachments/_attachments/logo.png
/static/logo.svg Engine static asset — served directly
https://example.com/logo.svg External URL — used as-is

Cascade inheritance

The icon cascades down the URL hierarchy. Set it once on a section homepage and every page in that section inherits it automatically.

Example: setting icon on the /inkstone homepage means all of /inkstone/getting-started, /inkstone/docs/dataview, etc. show the same icon — unless one of those pages sets its own icon: to override it.

The resolution order for any page at /a/b/c is:

  1. /a/b/c (the page itself)
  2. /a/b
  3. /a
  4. / (root homepage)

The first ancestor that has icon: set wins. If none do, no icon is shown.


Custom header title

site_title: replaces the website name displayed in the header <h1> for a page and all its children.

---
website: true
type: homepage
title: InkStone Docs
site_title: "InkStone"
---

This is useful when a section of your site has a distinct brand from the root. The cascade rules are identical to icon: — set it on a section homepage and every child page inherits it.

icon: and site_title: are independent — you can set either or both. A child page can override one without affecting the other.


Full example

Root homepage — sets the default icon and title for the whole site:

---
website: true
type: homepage
title: Anton Bakulin
icon: _attachments/avatar.jpg
---

InkStone section homepage — overrides both for everything under /inkstone:

---
website: true
type: homepage
title: InkStone
icon: /static/logo.svg
site_title: "InkStone"
---

A single post — overrides the icon for that page only:

---
website: true
title: My Photography
icon: _attachments/camera-icon.svg
---

See also