KB4IT Help

Start

• Build your first website
  Install, create, write, build, open.
• Install or upgrade KB4IT
  On Linux, macOS or Windows, with uv, pipx or pip.
• How KB4IT works
  Files in, website out, and why it is fast.

Write

• Write a document
  Properties, title, sections, links, notes, diagrams, formulas and images.
• How properties become navigation
  Every property you use gets its own pages.
• Document format
  The exact rules a document must follow.
• Diagrams and formulas
  Mermaid diagrams and math, with the source of each example.

Build and publish

• Build and rebuild a website
  Fast rebuilds, full rebuilds and checks.
• Preview while you write
  kb4it serve rebuilds and reloads the page when you save.
• Use the terminal interface
  Manage, build and browse projects from one screen.
• Publish on GitHub Pages
  Build and publish on every push.
• Publish on any web server
  Copy one folder; no server software needed.

Choose a look

• Themes
  Pick the theme that fits what you write.
• techdoc, blog, bookshelf, apphelp
  What each bundled theme offers.
• Change one template
  Adjust a theme for one site, without copying it.
• Create your own theme
  Templates, logic and where to install it.

Look something up

• Command line
  Every command and option.
• Repository settings
  Every key of repo.json.
• Troubleshooting, questions and tips
  When something does not look right.

Develop KB4IT

• How KB4IT is built
  Services, build stages and the cache.
• Run and test from source
  Clone, test and check the themes.
• Release a version and write these pages
  For maintainers.