Change one template of a theme

1. Create the folder overrides/templates/ next to config/ and source/.

2. Copy the template you want to change from the theme into it, keeping its name. The bundled themes are in the KB4IT package; this prints the folder of techdoc:

   Copy

   python3 -c "import kb4it, os; print(os.path.join(os.path.dirname(kb4it.__file__), 'resources', 'themes', 'techdoc', 'templates'))"
   

3. Edit the copy and build. The build log shows TEMPLATE_OVERRIDE name=<template>, and every page is rebuilt.

KB4IT looks for a template in this order and uses the first it finds:

1. overrides/templates/ of the knowledge base.
2. The templates/ folder of the theme.
3. The common templates of KB4IT.

Delete the copy to go back to the theme's template.

Everything in overrides/static/ is copied, as it is, into the website root. Put stylesheets, scripts or images there, for example overrides/static/css/site.css, and link them from an overridden template.

Use another folder than overrides with "overrides": "my-folder" in repo.json.

Mermaid diagrams and KaTeX formulas are built in; see diagrams. For another browser library, such as a chart or a map:

1. Put the library file in overrides/static/js/.

2. Copy techdoc's HTML_FOOTER.tpl into overrides/templates/ and add the script lines just before its </body> line (anything after </html> is dropped):

   Copy

   <script src="js/library.min.js"></script>
   <script>startLibrary();</script>
   

3. Write what the library needs in a document as an HTML block. Markdown keeps HTML blocks as they are.