Getting started

To use the extension just write the following code inside your documentation and mkdoclingo will render the corresponding documentation in that place.

Example

::: relative-path-to-file.lp
    handler: asp
    options:
        ...

• relative-path-to-file.lp is a relative path to an ASP encoding from the project root
• handler: asp indicates that mkdoclingo will be used
• options customize each section that can be included.

Configuration options

• encodings See Encodings section
• predicate_table See Predicate table section
• glossary See Glossary section
• dependency_graph See Dependency graph section
• predicate_info Predicate filtering shared by glossary/table/graph (documented in the section pages above)
• start_level The initial markdown level. By default is 1

Follow the guide in Quick start guide to learn how to include an encoding in your documentation step by step.