Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

Step-by-step guide


Tip

The source code of our official guide is stored at Github: https://github.com/

...

Checkmk/checkmk-docs

...

You can use asciidoctor to convert the doc to PDF or HTML file

...



  1. Clone the repository:

...

  1. https://github.com/

...

  1. Checkmk/checkmk-docs

  2. Install asciidoctor: https://github.com/asciidoctor/asciidoctor

  3. Convert the files to PDF/HTML


Note

 At the moment, this is the only recommended way. We're considering providing a zip file, including the HTML docs.


There is a second way using wget -m. This way is not recommended due to missing functionality like the broken search. 

Use wget to download the docs:

Code Block
languagebash
themeRDark
 wget -m https://docs.checkmk.com/latest/en/ 


Now you can use a web server to visualize the html files or convert the files to pdf


Filter by label (Content by label)
showLabelsfalse
max5
spacesKB
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel in ("kb-how-to-article","howto") and type = "page" and space = "KB"
labelskb-how-to-article

...