Markdown PDF

This extension convert Markdown file to pdf, html, png or jpeg file.

Japanease README

Features

Supports the following features.

Usage

Command Palette

Open the Markdown file
Press F1 or Ctrl+Shift+P
Type pdf and select Convert Markdown to PDF

Menu

Open the Markdown file
Right click and select Convert Markdown to PDF

Auto convert

Add "markdown-pdf.convertOnSave": true option to settings.json
Restart Visual Studio Code
Open the Markdown file
Auto convert on save

Extension Settings

Visual Studio Code User and Workspace Settings

Select File > Preferences > UserSettings or Workspace Settings
Find markdown-pdf settings in the Default Settings
Copy markdown-pdf.* settings
Paste to the settings.json, and change the value

Options

{
	// Enable Auto convert on save
	"markdown-pdf.convertOnSave": false,

	// Excluded file name of convertOnSave option
	"markdown-pdf.convertOnSaveExclude": [
		"^work",
		"work.md$",
		"work|test",
		"[0-9][0-9][0-9][0-9]-work",
		"work\\d"  // \d -> \\d. All '\' need to be written as '\\'.
	],

	// Output Directory
	"markdown-pdf.outputDirectory": "C:\\work",

	// A list of local paths to the stylesheets to use from the markdown-pdf
	"markdown-pdf.styles": [
		"C:\\Users\\<USERNAME>\\Documents\\markdown-pdf.css",  // OK (Windows)
		"C:\Users\<USERNAME>\Documents\markdown-pdf.css",      // N/A. All '\' need to be written as '\\'. (Windows)
		"C:/Users/<USERNAME>/Documents/markdown-pdf.css",      // OK (Windows)
		"/home/<USERNAME>/settings/markdown-pdf.css",          // OK
		".vscode\\markdown-pdf.css",                           // OK. Relative path (Windows)
		".vscode/markdown-pdf.css",                            // OK. Relative path
		"markdown-pdf.css.css"                                 // OK. Relative path
	],

	// Set the style file name. for example: github.css, monokai.css ...
	// fine name list : https://github.com/isagalaev/highlight.js/tree/master/src/styles
	// demo site : https://highlightjs.org/static/demo/
	"markdown-pdf.highlightStyle": "github.css",

	// Enable Syntax highlighting
	"markdown-pdf.highlight": true,

	// Enable line breaks
	"markdown-pdf.breaks": false,

	// Enable emoji. http://www.webpagefx.com/tools/emoji-cheat-sheet/
	"markdown-pdf.emoji": true,

	// Output format: pdf, html, png, jpeg
	"markdown-pdf.type": "pdf",

	// Only used for types png & jpeg
	"markdown-pdf.quality": 90,

	// Page Option. Page size: A3, A4, A5, Legal, Letter, Tabloid
	"markdown-pdf.format": "A4",

	// Page Option. portrait or landscape
	"markdown-pdf.orientation": "portrait",

	// Page Option. Border Top. units: mm, cm, in, px
	"markdown-pdf.border.top": "1.5cm",

	// Page Option. Border bottom. units: mm, cm, in, px
	"markdown-pdf.border.bottom": "1cm",

	// Page Option. Border right. units: mm, cm, in, px
	"markdown-pdf.border.right": "1cm",

	// Page Option. Border left. units: mm, cm, in, px
	"markdown-pdf.border.left": "1cm",

	// Header contents
	"markdown-pdf.header.contents": "",

	// Header height. units: mm, cm, in, px
	"markdown-pdf.header.height": "",

	// Footer contents
	"markdown-pdf.footer.contents": "<div style=\"text-align: center;\">{{page}}/{{pages}}</div>",

	// Footer height. units: mm, cm, in, px
	"markdown-pdf.footer.height": "0.8cm"

}

F.A.Q.

How can I change emoji size ?

Add the following to your stylesheet which was specified in the markdown-pdf.styles.

.emoji {
  height: 2em;
}

Release Notes

0.1.8 (2018/02/21)

Add: Feature allowing use of PlantUML in a markdown document.

0.1.7 (2017/04/05)

Change: Display completion message on status bar #19
Add: markdown-pdf.convertOnSaveExclude option #16
Fix: broken code-blocks #18
Fix: Image path error #14
Update: markdown.css of the vscode
Update: dependencies packages

License

MIT

Special thanks

and

cakebake/markdown-themeable-pdf

License

primos63/vscode-markdown-pdf

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages