Skip to content

Publishing

Publishing renders a notebook as a public website — navigation, rendered Markdown, diagrams, search — at:

kyra-hi.com/p/<your-username>/<notebook>

Good for: documentation, a handbook, research you want cited, a public digital garden, anything you would otherwise stand up a static site for.

Notebook Settings, then:

  1. Choose the default branch for Git clients.
  2. Turn on Publish this notebook.
  3. Choose the branch to publish from.
  4. Save.

Publishing reads its rules from a kyra.toml file at the notebook root. Edit it from the publish settings page or as a file.

default_public = true
hide_private_titles = false
private_globs = ["internal/*", "drafts/**/*.md"]
SettingEffect
default_publicWhether pages are public unless a rule says otherwise.
private_globsPaths that stay private. Members can read them; the public cannot.
hide_private_titlesWhether private pages are hidden from public navigation entirely, or shown with a lock.

* does not cross a /. Use ** to match deeper:

private_globs = [
"internal/*", # internal/notes.md — yes. internal/hr/pay.md — no.
"internal/**/*.md", # everything under internal/, at any depth.
]

Navigation comes from a SUMMARY.md at the notebook root — an ordered list of the pages you want, in the order you want them. It is separate from the folder structure on purpose: the way you file things and the way a reader should move through them are rarely the same.

Without one, Kyra falls back to the file tree.

Published content comes from the branch you selected, so branches work as versions. Keep main as what readers see, prepare the next version on a branch, then switch when it is ready. See branches.

  • Rendered Markdown with working navigation and prev/next
  • Diagrams and maths, rendered
  • Search across the public pages
  • Your chosen light or dark theme
  • No cookies, no trackers

Turn off Publish this notebook and the public site stops serving.