OwnShip Guide

Configuration

OwnShip is configured via a plain site.ini file that lives next to index.php. Every line is optional — sensible defaults apply if a line is absent, or if the file is absent entirely.

# site.ini
title             = My Site
theme             = light      # light | dark | sepia
clean_urls        = false      # true needs .htaccess on Apache
show_theme_button = true       # show/hide the theme cycle button
show_search       = true       # show/hide the 🔍 search button
logo_height       = 32         # header image height in px
content_width     = 0          # max content width in px (0 = no limit)

Options

title — Site name shown in the header and browser tab. If omitted, OwnShip uses the first # H1 heading in your index.md home page. If neither is present, falls back to My Site.

theme — Starting theme. Readers can cycle through themes and their preference is saved locally. Default: light.

clean_urls — When true, pages serve as /my-page instead of ?page=my-page. Requires an .htaccess file on Apache — see Clean URLs. Default: false.

show_theme_button — Controls visibility of the ☀ / 🌙 / ⛅ theme cycle button in the header. Default: true.

show_search — Controls visibility of the 🔍 search button in the nav pane. When enabled, readers can search page titles and content with live filtering of the nav tree. Set to false for single-page or business-card sites where search adds no value. Default: true. See Search.

logo_height — Height in pixels of an image used in _header.md or _header.html. Default: 32.

content_width — Maximum width of the content area in pixels. Useful for narrower layouts like business-card sites, or wider layouts for documentation. 0 means no limit — content stretches to fill the available pane. Default: 0.

For deeper color control — overriding heading colors, link colors, or any part of the built-in palette — see Custom Themes.