gchq/CyberChef

Feature request: Markdown To PDF

Open

#1496 opened on Jan 4, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (34,843 stars) (3,944 forks)batch import
featurehelp wantedimprovement

Description

We currently have a Render Markdown operation, it would be good if we could render the markdown and then save the output as a PDF.

This could be an extension of the Render Markdown operation through a checkbox or it could potentially be it's own standalone operation.

There seems to be a good amount of libraries that achieve converting markdown files into PDFs so hopefully this operation will be fairly trivial to implement.

Contributor guide

Tech stack
javascripthtmlcss
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
First, examine the existing 'Render Markdown' operation to understand how markdown is converted to HTML (likely using marked or similar). Then explore client side PDF generation libraries such as jsPDF or html2pdf.js to convert the rendered HTML to PDF. Look for existing operations that output files to understand the pattern for saving/downloads. No open PRs or conflicting work found.