Khalid / Docs

Khalid docs

How to install Khalid, start a blog, put it online and set it up. Each page is written in the Khalid repository, beside the code it describes.

Getting started with Khalid

This page takes you from nothing to a published post, then shows how to check the site, sign in to the admin, bring in an old blog.

Running Khalid on a server

Khalid is one file. Put it on a machine, point it at a site folder, and it serves the blog and the admin. This page shows the ways to keep it running.

A free Khalid blog on Cloudflare

Templates: the look of your blog

A template sets the layout and features of your blog's pages: where the contents list sits, which cards the home page shows.

ClassicAlmanacAtlasCompassFolioHarborKeystoneLedgerMeridianWireWorkbench

The blog's addresses: routes.toml

routes.toml sits beside site.toml and sets how the blog's web addresses look.

SEO settings

Every SEO setting lives in site.toml, under [seo]. Each one has a default, so a site works with none of them set.

The admin's SEO tools

The admin carries the tools the Yoast SEO plugin gives a WordPress site, where they apply to Khalid.

Reading aids

Four small aids help a reader find their way through a long post. Every template has them, classic too.

Newsletters

Readers sign up with a plain form, confirm with one click in an email, and leave with one click in any email after that.

Charts, embedded tools and tracking tags

Three ways to make a post do more: draw numbers as a chart, show an interactive tool from a site you trust.