KB4IT

A static document repository generator based on Asciidoctor

This project replaces the old and never finished KB4IT (renamed now to SW-KB4IT)

Introduction

KB4IT is a static document generator based on Asciidoctor markdown.

Main goals:

  • Easy to write technical documentation
  • Easy to find documentation
  • Easy to publish documentation
  • Easy to backup/restore documentation

Demo

See a demo here.

Download

Get a copy from the SVN repository:

svn checkout https://subversion.t00mlabs.net/kb4it/trunk kb4it

Execution

usage: kb4it.py [-h] [-sp SOURCE_PATH] [-tp TARGET_PATH] [-v LOGLEVEL [DEBUG|INFO|ERROR]]
                [--version]

KB4IT by Tomás Vírseda

optional arguments:
  -h, --help            show this help message and exit
  -sp SOURCE_PATH, --source-path SOURCE_PATH
                        Path for Asciidoc source files.
  -tp TARGET_PATH, --target-path TARGET_PATH
                        Path for output files
  -v LOGLEVEL, --verbosity LOGLEVEL
                        Increase output verbosity
  --version             show program's version number and exit

All parameters are optional.

After execute the script, you should get an output similar to this:

   INFO |  818  | 2018-08-30 23:05:39,196 | KB4IT - Knowledge Base for IT
   INFO |  803  | 2018-08-30 23:05:39,210 | 1. Target directory clean
   INFO |  827  | 2018-08-30 23:05:39,211 | 2. Got 68 docs from source directory
   INFO |  775  | 2018-08-30 23:05:39,345 | 3. Preprocessed 68 docs
   INFO |  489  | 2018-08-30 23:05:43,079 | 4. Document's metadata processed
   INFO |  632  | 2018-08-30 23:05:44,488 |     Compiling:   5% done
   INFO |  632  | 2018-08-30 23:05:45,726 |     Compiling:  10% done
   INFO |  632  | 2018-08-30 23:05:47,112 |     Compiling:  15% done
   INFO |  632  | 2018-08-30 23:05:48,260 |     Compiling:  20% done
   INFO |  632  | 2018-08-30 23:05:49,324 |     Compiling:  25% done
   INFO |  632  | 2018-08-30 23:05:50,504 |     Compiling:  30% done
   INFO |  632  | 2018-08-30 23:05:51,804 |     Compiling:  36% done
   INFO |  632  | 2018-08-30 23:05:52,889 |     Compiling:  41% done
   INFO |  632  | 2018-08-30 23:05:54,109 |     Compiling:  46% done
   INFO |  632  | 2018-08-30 23:05:55,345 |     Compiling:  51% done
   INFO |  632  | 2018-08-30 23:05:56,709 |     Compiling:  56% done
   INFO |  632  | 2018-08-30 23:05:57,909 |     Compiling:  61% done
   INFO |  632  | 2018-08-30 23:05:59,069 |     Compiling:  67% done
   INFO |  632  | 2018-08-30 23:06:00,192 |     Compiling:  72% done
   INFO |  632  | 2018-08-30 23:06:01,375 |     Compiling:  77% done
   INFO |  632  | 2018-08-30 23:06:02,376 |     Compiling:  82% done
   INFO |  632  | 2018-08-30 23:06:03,556 |     Compiling:  87% done
   INFO |  632  | 2018-08-30 23:06:04,801 |     Compiling:  92% done
   INFO |  632  | 2018-08-30 23:06:05,780 |     Compiling:  97% done
   INFO |  633  | 2018-08-30 23:06:05,890 |     Compiling: 100% done
   INFO |  634  | 2018-08-30 23:06:05,890 | 5. Documents compiled successfully.
   INFO |  789  | 2018-08-30 23:06:05,987 | 6. Compiled documents copied to target directory
   INFO |  853  | 2018-08-30 23:06:06,000 | 7. Source docs copied to target directory
   INFO |  854  | 2018-08-30 23:06:06,000 | Execution finished