Open SoC Debug Documentation Converter

The Open SoC Debug documentation is written inMarkdown. For optimal viewing it can be converted into HTML or PDF outputdocuments. The Docker container inside this repository contains an applicationto perform this conversion.

The conversion is handled by pandoc, which is combinedwith additional plugins (filters) for modifying the output to fit our needs.

Features:

PDF and HTML5 output

SVG images are supported

Cross-references inside the document are supported using thepandoc-crossrefsyntax.

Convert documents

Nothing simpler than that! You only need to install Docker and a small runscript to invoke the application inside the container.

Install Docker (if you don't already have it installed)

On Ubuntu, run (note the package name!)

$ sudo apt-get install docker.io

Get the run script

This repository contains a script which runs Docker with the necessary options.You can either use it from this repository, or download it from GitHub.

Convert documents

Call osd-doc-converter to convert documents.

Important note on file paths:The conversion script cannot access any file in the directory hierarchy abovethe directory in which you execute the script (the current working directory).Usually, you should run the script from the topmost directory that contains yourinput files and possibly any templates.