light-markdown-pdf
Lightweight conversion scheme from markdown to pdf.
Warn
Because the Chinese font file is too large, npm cannot upload it.
Please download the font file from github and use a custom configuration.
Intro
No Puppeteer or PhantomJS dependency.
Use CommonMark to convert markdown files to abstract syntax tree (AST), and then use pdfkit to convert to pdf files.
Unsupported
Features outside the specification are not supported.
e.g.
- table
- strike
Supported
Features inside the specification are supported.
e.g.
- document (bookmark)
- text
- linebreak
- softbreak
- emph
- strong
- link (http/anchor)
- thematic_break
- heading (bookmark)
- paragraph
- image (http/local png/jpg)
- code
- code_block (syntax highlighter)
- block_quote (nested)
- list (ordered/unordered/nested)
- item
- html_inline (like code)
- html_block (like code_block)
Issues
1. Sometimes the anchor will fail for unknown reasons.
Usage
$3
``shell
npm install --save light-markdown-pdf
`
$3
`shell
lmp --help
Usage: lmp [options]
Lightweight conversion scheme from markdown to pdf
Options:
-V, --version output the version number
-s, --sourceDir
input *.md file directory
-t, --targetFile output *.pdf file path
-c, --configFile custom config file path
--verbose output all log
--coverTitle pdf cover title<br /> --coverAuthor <author> pdf cover author<br /> --coverVersion <version> pdf cover version<br /> --fontName <name> default font name<br /> --fontFile <file> default font file path<br /> --ignoreDirBookmark don't use directory name as bookmark<br /> --ignoreFileBookmark don't use file name as bookmark<br /> -h, --help display help for command<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"><h3 class="text-lg font-medium mt-4 mb-2">$3</h3></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">shell<br />lmp --sourceDir . --targetFile $npm_package_name.pdf --fontName PingFang --fontFile ./src/asset/PingFang-SC-Regular.ttf --coverTitle $npm_package_name --coverAuthor $npm_package_author_name --coverVersion $npm_package_version --ignoreFileBookmark<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3">or</p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">shell<br />lmp --configFile ./src/config.js<br /></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono"></p><p class="my-3"></code>`<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">javascript<br />// ./src/config.js</p><p class="my-3">const path = require('path');<br />const pkg = require('../package.json');</p><p class="my-3">module.exports = {<br /> sourceDir: process.cwd(),<br /> targetFile: path.join(process.cwd(), </code>${pkg.name}.pdf<code class="bg-muted px-1 py-0.5 rounded text-sm font-mono">),<br /> font: {<br /> defaultFontName: 'PingFang',<br /> registerFont: {<br /> PingFang: path.join(process.cwd(), 'src/asset/PingFang-SC-Regular.ttf'),<br /> },<br /> },<br /> cover: {<br /> title: pkg.name,<br /> author: pkg.author,<br /> version: pkg.version,<br /> },<br />}<br /></code>``<br /></p></div><div class="flex justify-center absolute inset-x-0 bottom-0 bg-gradient-to-t from-background via-background to-transparent pb-4 pt-16"><button data-slot="button" class="inline-flex items-center justify-center whitespace-nowrap text-sm font-medium transition-all disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive border bg-background shadow-xs hover:bg-accent hover:text-accent-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 h-8 rounded-md gap-1.5 px-3 has-[>svg]:px-2.5"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-chevron-down mr-1 h-4 w-4"><path d="m6 9 6 6 6-6"></path></svg>Show more</button></div></div></div><template id="P:3"></template><template id="P:4"></template></div></div></div><script>self.__next_f.push([1,"29:[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}]\n2a:[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"^0.29.1\"}]\n2b:[\"$\",\"$L5\",\"image-size\",{\"href\":\"/package/image-size\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"image-size\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"^0.8.3\"}]]}]\n2c:[\"$\",\"$L5\",\"pdfkit\",{\"href\":\"/package/pdfkit\",\"className\":\"group flex items-center justify-between rounded-md px-2 py-1.5 text-sm transition-colors hover:bg-accent\",\"children\":[[\"$\",\"span\",null,{\"className\":\"flex items-center gap-1.5 truncate font-mono text-foreground\",\"children\":[[\"$\",\"svg\",null,{\"ref\":\"$undefined\",\"xmlns\":\"http://www.w3.org/2000/svg\",\"width\":24,\"height\":24,\"viewBox\":\"0 0 24 24\",\"fill\":\"none\",\"stroke\":\"currentColor\",\"strokeWidth\":2,\"strokeLinecap\":\"round\",\"strokeLinejoin\":\"round\",\"className\":\"lucide lucide-chevron-right h-3 w-3 text-muted-foreground opacity-0 transition-opacity group-hover:opacity-100\",\"children\":[[\"$\",\"path\",\"mthhwq\",{\"d\":\"m9 18 6-6-6-6\"}],\"$undefined\"]}],\"pdfkit\"]}],[\"$\",\"span\",null,{\"className\":\"ml-2 shrink-0 font-mono text-xs text-muted-foreground\",\"children\":\"^0.11.0\"}]]}]\n"])</script><div hidden id="S:3"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-dependencies" hidden="" id="radix-_R_aav5ubrb_-content-dependencies" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS=function(a,b){a=document.getElementById(a);b=document.getElementById(b);for(a.parentNode.removeChild(a);a.firstChild;)b.parentNode.insertBefore(a.firstChild,b);b.parentNode.removeChild(b)};$RS("S:3","P:3")</script><div hidden id="S:4"><div data-state="inactive" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-_R_aav5ubrb_-trigger-versions" hidden="" id="radix-_R_aav5ubrb_-content-versions" tabindex="0" data-slot="tabs-content" class="flex-1 outline-none mt-6"></div></div><script>$RS("S:4","P:4")</script><script>$RC("B:1","S:1")</script></body></html>