Every page, grouped by feature.
Getting started
- Tutorial Get started with KB4IT
Install KB4IT, create a knowledge base, write a document and open your first website. - Explanation How KB4IT works
Files in, website out. What KB4IT does with your documents and why rebuilds are fast. - Reference Frequently asked questions
Short answers to the questions people ask most about KB4IT.
Installation
- How-to guide Install KB4IT
Install KB4IT on Linux, macOS or Windows with uv, pipx, pip, a Linux package or a container, upgrade it, remove it, or run it from a clone.
Writing
- Explanation How properties become navigation
Every property you use becomes a page, and every value becomes a list of the documents that share it. - How-to guide Write a document
Write a document with properties, a title, sections, links to other documents, notes, code, diagrams, formulas, tables and images. - Reference Document format
The rules a source document must follow, the date formats KB4IT reads and the reasons a document is rejected. - Reference Diagram and formula gallery
Examples of diagrams and formulas, each with the Markdown you write and the result readers see. - How-to guide Troubleshooting
What to do when a document is missing, a link is broken, a theme is refused or the build stops. - Reference Frequently asked questions
Short answers to the questions people ask most about KB4IT. - How-to guide Tips
Small things that make writing and building with KB4IT easier.
Building
- Explanation How KB4IT works
Files in, website out. What KB4IT does with your documents and why rebuilds are fast. - How-to guide Build and rebuild a website
Build a website, rebuild only what changed, force a full rebuild, check documents and read the build log. - How-to guide Preview while you write
See your changes in the browser while you write, with kb4it serve. - How-to guide Run your own code during a build
Run your own Python code at fixed points of a build, without writing a theme. - Reference Command line
Every kb4it command and option, and what the exit status means. - Reference Log codes
Every error and warning code KB4IT writes to its log, what it means and what to do. - How-to guide Troubleshooting
What to do when a document is missing, a link is broken, a theme is refused or the build stops. - How-to guide Tips
Small things that make writing and building with KB4IT easier.
Publishing
- How-to guide Publish on GitHub Pages
Keep the knowledge base in a GitHub repository and publish it on GitHub Pages on every push. - How-to guide Publish on any web server
Share the website by copying one folder to a web server, a file share or a laptop. - Reference GitHub Action
The inputs and outputs of the KB4IT GitHub Action, which builds a site in a GitHub workflow. - Reference Frequently asked questions
Short answers to the questions people ask most about KB4IT.
Themes
- Explanation Themes
What a theme is, the four themes that come with KB4IT and how to pick one. - How-to guide Change one template of a theme
Change one template of a theme, or add your own CSS and scripts, without copying the whole theme. - How-to guide Create your own theme
Make your own theme, starting from a bundled one or from a small working example. - Reference techdoc
The techdoc theme for team knowledge bases, the properties it reacts to and its settings. - Reference blog
The blog theme, how to write a post with an excerpt and the settings it reads. - Reference bookshelf
The bookshelf theme for study notes organised as books, parts and chapters, with reading progress. - Reference apphelp
The apphelp theme for application help sites, its page properties, help ids and settings. - Reference Log codes
Every error and warning code KB4IT writes to its log, what it means and what to do. - How-to guide Troubleshooting
What to do when a document is missing, a link is broken, a theme is refused or the build stops.
Terminal interface
- How-to guide Use the terminal interface
Create, build, explore and preview your knowledge bases from a full-screen terminal interface. - How-to guide Tips
Small things that make writing and building with KB4IT easier.
Configuration
- Explanation How properties become navigation
Every property you use becomes a page, and every value becomes a list of the documents that share it. - Reference techdoc
The techdoc theme for team knowledge bases, the properties it reacts to and its settings. - Reference blog
The blog theme, how to write a post with an excerpt and the settings it reads. - Reference bookshelf
The bookshelf theme for study notes organised as books, parts and chapters, with reading progress. - Reference apphelp
The apphelp theme for application help sites, its page properties, help ids and settings. - Reference Command line
Every kb4it command and option, and what the exit status means. - Reference Repository settings
Every setting of config/repo.json shared by all themes, with its default. - Reference Log codes
Every error and warning code KB4IT writes to its log, what it means and what to do.
Development
- Explanation How KB4IT is built
How KB4IT is put together, from the command line to the files in target/, and how incremental builds work. - How-to guide Create your own theme
Make your own theme, starting from a bundled one or from a small working example. - How-to guide Run and test from source
Get the source, run KB4IT from it, run the tests and the theme check, and send a change. - How-to guide Release a version
Cut a KB4IT release, from the changelog to PyPI, the container image and the GitHub release. - How-to guide Write these pages
Add or change a page of this help, check it locally and get it published.