Skip to content
KB4IT Help

Frequently asked questions

On this page

Short answers. Each one links to the page with the details.

Do I need a server or a database?

No. The website is plain files. Open it from disk or copy it to any web server. Publish on any web server

Does it work on Windows or macOS?

KB4IT is developed and tested on GNU/Linux. The websites it makes work in any browser on any system.

Can I use subfolders in source/?

No. KB4IT reads the documents directly in source/. Use properties such as Category or Topic to group them instead; they give readers better navigation than folders. How properties become navigation

Can I write in AsciiDoc?

No. Older versions used AsciiDoc; KB4IT now reads Markdown only.

Where do images go?

In source/resources/images/, linked as resources/images/name.png. Add images

Can I keep the knowledge base in git?

Yes, and it is a good idea. Commit config/ and source/, and ignore var/ and target/. Publish on GitHub Pages

Can I change the theme later?

Yes. Change "theme" in repo.json and build with --force. Your documents stay the same. Themes

Why did a build compile nothing?

Nothing changed since the last build. That is the fast path working. Rebuild everything if you need to.

How do I start over?

Delete the var/ and target/ folders of the knowledge base and build again. Your documents in source/ are not affected.