Gathering detailed insights and metrics for electron-md-to-pdf
Gathering detailed insights and metrics for electron-md-to-pdf
:electron: Convert Markdown to PDF in Electron apps Convert Markdown to PDF in Electron apps
Installations
npm install electron-md-to-pdfDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Releases
7
Languages
3
CSS
TypeScript
HTML
CSS (73.08%)
TypeScript (25%)
HTML (1.93%)
Developer
samuelmeuli
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
2 Stars
35 Commits
2 Watchers
3 Branches
1 Contributors
Updated on Jan 28, 2023
Maintainers
1
Package Meta Information
Latest Version
2.2.0
Package Id
electron-md-to-pdf@2.2.0
Unpacked Size
15.89 kB
Size
5.80 kB
File Count
8
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Peer Dependencies
1
Dev Dependencies
19
@samuelmeuli/eslint-config@samuelmeuli/prettier-config@samuelmeuli/tsconfig@typescript-eslint/eslint-plugin@typescript-eslint/parserelectronelectron-debugelectron-unhandledeslinteslint-config-airbnb-baseeslint-config-prettiereslint-plugin-importeslint-plugin-simple-import-sorthuskylint-stagednpnpm-run-allprettiertypescript
electron-md-to-pdf
Convert Markdown to PDF in Electron apps
This simple library first converts a Markdown string to HTML (using Showdown) and then to PDF (using Chromium's built-in print functionality). This makes it possible to convert Markdown to PDF with a minimal number of dependencies in Electron apps.
Installation
1npm install electron-md-to-pdf
Usage
This module exposes two functions:
mdToPdfBuffer(md, options), which generates a PDF from the provided Markdown string (md) and returns it as aBuffermdToPdfFile(md, filePath, options), which generates a PDF from the provided Markdown string and saves it at the providedfilePath
Both functions return promises.
The options parameter is optional. It's an object which may contain the following values:
basePath(String): Base directory for relative paths of resources, e.g. images. Default: Current directorycssString(String): CSS string to inject into the HTML which is generated from the Markdown string (e.g."body { color: red; }")cssFiles(String array): Array of CSS files to inject into the HTML (e.g.["./path/to/styles.css"])mdFlavor(String): Markdown flavor to use, one of["original", "vanilla", "github"](see the Showdown docs). Default is"github"pdfOptions(Object): Options to pass to Electron's PDF print function (see the Electron docs)showdownOptions(Object): Other options for the HTML generation (see the Showdown docs)wrapperClasses(String): Class(es) to apply to the wrapperdivaround the Markdown HTML
See the examples on how to use the module in the main process and renderer process.
Development
Make sure you have Node.js and Yarn installed.
- Clone this repo:
git clone REPO_URL - Install the dependencies:
yarn - Run the test app:
yarn start
Contributing
Suggestions and contributions are always welcome! Please first discuss changes via issue before submitting a pull request.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
Found 0/28 approved changesets -- score normalized to 0
Reason
project is archived
Details
- Warn: Repository is archived.
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 2 are checked with a SAST tool
Reason
43 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-6vrv-94jv-crrg
- Warn: Project is vulnerable to: GHSA-f9mq-jph6-9mhm
- Warn: Project is vulnerable to: GHSA-h9jc-284h-533g
- Warn: Project is vulnerable to: GHSA-m93v-9qjc-3g79
- Warn: Project is vulnerable to: GHSA-hvf8-h2qh-37m9
- Warn: Project is vulnerable to: GHSA-mpjm-v997-c4h4
- Warn: Project is vulnerable to: GHSA-3p22-ghq8-v749
- Warn: Project is vulnerable to: GHSA-77xc-hjv8-ww97
- Warn: Project is vulnerable to: GHSA-mq8j-3h7h-p8g7
- Warn: Project is vulnerable to: GHSA-p2jh-44qj-pf2v
- Warn: Project is vulnerable to: GHSA-p7v2-p9m8-qqg7
- Warn: Project is vulnerable to: GHSA-7x97-j373-85x5
- Warn: Project is vulnerable to: GHSA-7m48-wc93-9g85
- Warn: Project is vulnerable to: GHSA-qqvq-6xgj-jw8g
- Warn: Project is vulnerable to: GHSA-6r2x-8pq8-9489
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-v4rh-8p82-6h5w
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.7
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More