GithubHelp home page GithubHelp logo

audit-report-templating's Introduction

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
  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.

audit-report-templating's People

Contributors

patrickalphac avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.