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.
Turning it on
Section titled “Turning it on”Notebook Settings, then:
- Choose the default branch for Git clients.
- Turn on Publish this notebook.
- Choose the branch to publish from.
- Save.
Choosing what is public
Section titled “Choosing what is public”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 = truehide_private_titles = falseprivate_globs = ["internal/*", "drafts/**/*.md"]| Setting | Effect |
|---|---|
default_public | Whether pages are public unless a rule says otherwise. |
private_globs | Paths that stay private. Members can read them; the public cannot. |
hide_private_titles | Whether 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
Section titled “Navigation”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.
Versions
Section titled “Versions”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.
What readers get
Section titled “What readers get”- 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
Un-publishing
Section titled “Un-publishing”Turn off Publish this notebook and the public site stops serving.