Skip to main content

Markdown Features

geol documentation supports standard Markdown features : it is optimized for Github-flavored variant.

The pandoc toolchain​

pandoc is a document converter that can transform Markdown (which is useful for our workflow) and many other input formats into various output formats such as EPUB, PDF, DOCX, HTML, and more. Typical workflow:

Requirements​

  • pandoc — install with Homebrew using the following command:
brew install pandoc

See https://pandoc.org/installing.html for more details.

Produce and convert a report​

Produce geol-report.md with geol. For example, generate a description of Ubuntu and save it to a Markdown file:

geol product describe ubuntu > geol-report.md

This command also accepts multiple products — for example:

geol product extended ubuntu linux windows > geol-report.md

Convert the Markdown report to other formats with pandoc:

This command converts the Markdown file into an EPUB e-book.

pandoc geol-report.md -o geol-report.epub

This command converts the Markdown file into a standalone HTML file (-s).

pandoc geol-report.md -s -o geol-report.html

This command converts the Markdown file into a PDF using XeLaTeX (--pdf-engine=xelatex) to generate the PDF output.

pandoc geol-report.md -o geol-report.pdf --pdf-engine=xelatex