ASVS icon indicating copy to clipboard operation
ASVS copied to clipboard

Proposal: use markdown HTML templating for PDF generation

Open ike opened this issue 3 years ago • 8 comments

I found a few methods for generating PDFs from markdown using HTML templates. I presume that this would greatly shrink the size of the docker build image, and would possibly be a more accessible tool chain for future contributors or for teams maintaining their own forks.

I understand that this would be a departure from the existing DOCX generator, and from the new Latex endeavors. This is meant as a jumping off point for discussing the pros and cons, and is not meant to say that the existing tools don't have merit.

In a general order of preference, here are some of the methods and tools I've found:

  1. WeasyPrint (github)
  2. md-to-pdf
  3. markdown-pdf
  4. marked + wkhtmltopdf
  5. pdfkit + Python Markdown

ike avatar Nov 18 '21 09:11 ike

Whatever works! For me it seems reasonable.

My worry is that there are parallel works to solve the same problem and in the end some of them is wasted time. To avoid that, please sync goals and information with "makefile" team.

elarlang avatar Nov 18 '21 09:11 elarlang

Hey @elarlang I would say @ike IS the "makefile" team at this point. At least the manager of it. And he is in sync with Josh and the original makefile author.

jmanico avatar Nov 18 '21 15:11 jmanico

Would love thoughts from @tghosth and @lfservin on this one. If no one objects, I can work on a proof of concept PR.

ike avatar Nov 19 '21 18:11 ike

I'm flexible, to me the end result is what is important

tghosth avatar Nov 20 '21 20:11 tghosth

The only objection I would have is the customization of the ASVS by anyone interested in adopting it for their own purposes. I agree that latex is sometimes cumbersome, but it's not too difficult to change a couple of things and then you have a document that will surely match your company's look and feel for policies.

lfservin avatar Jun 08 '22 16:06 lfservin

Hi @ike, what was decided on this in the end, did you discuss with @lfservin ?

tghosth avatar Jul 04 '22 15:07 tghosth

I don't think this was fully decided -- I have been putzing on a POC but haven't given it an enormous amount of work.

ike avatar Jul 06 '22 18:07 ike

Ok so do we want to keep this issue open or is this just another part of the overall export functionality issue?

tghosth avatar Jul 26 '22 17:07 tghosth

I think we should close this. It's possibly a good direction to move, but I think we should push behind @lfservin's LaTeX strategy for now, at least for 5.0.

ike avatar Aug 24 '22 06:08 ike