Skip to content

Cyfrin/audit-report-templating

Repository files navigation

How to generate a PDF audit report


Chainlink Brownie logo


  1. Add all your findings to a markdown file like report-example.md
    1. Add the metadata you see at the top of that file
  2. Install pandoc & LaTeX
    1. You might also have to install one more package if you get File 'footnotebackref.sty' not found.
  3. Download eisvogel.latex and add to your templates directory (should be ~/.pandoc/templates/)
  4. Add your logo to the directory as a pdf named logo.pdf
  5. Run this command:
pandoc report-example.md -o report.pdf --from markdown --template=eisvogel --listings

FAQ

Certain characters like do not work with pandoc, and you'll need to remove them to generate your final report.

Alternative way to generate a PDF audit report

  • Step 1: Install the Markdown PDF extension in VS Code
  • Step 2: Copy example markdown file
  • Step 3: Add logo file (png, jpeg or svg)
  • Step 4: Press Cmd+Shift+P If you are on Mac. For Windows check the Markdown PDF extension for details.
  • Step 5: Type markdown-pdf: Export (pdf)