Site Metadata

Updated Apr 28, 2026

A few top-level fields on livemark.config.ts describe your site to browsers, search engines, and social cards.

Fields

livemark.config.ts
import { defineConfig } from "livemark"

export default defineConfig({
  include: "docs/**/*.md",
  site: "https://example.com",
  title: "My Docs",
  description: "Everything you need to build things.",
  logo: "/logo.svg",
  favicon: "/favicon.ico",
})
FieldTypeDefaultWhere it surfaces
sitestringCanonical origin used by the sitemap and absolute URLs
titlestring"Livemark"<title>, Open Graph og:title, header site title
descriptionstring"Markdown site generator"<meta name="description">, og:description
logostringImage shown next to the site title in the header (and as favicon default)
faviconstringlogo ?? bundled defaultBrowser tab icon

Sitemap and site

If site is set, Livemark builds a sitemap.xml at the root of your output during docs:build, using site as the absolute origin for every URL. Without site, sitemap generation is skipped.

Logo and favicon

  • logo and favicon accept any URL or root-relative path (/logo.svg). Assets placed in .livemark/public/ are served at /… and work well here.
  • If favicon is omitted, Livemark falls back to logo, and finally to its bundled mark.
  • The MIME type is inferred from the extension (.svg, .png, .ico).

See also

Built with and Livemark