Skip to content
This repository was archived by the owner on Dec 7, 2020. It is now read-only.

cakebake/markdown-themeable-pdf

 
 

Repository files navigation

Themeable Markdown Converter

Version Total Downloads Build Status Build status Dependencies License js-standard-style

This Atom package converts / prints / exports your markdown file simple and pretty to PDF, HTML, JPEG or PNG format.

The package was created at the beginning to help in the daily work with manuals for customers. Many people are not familiar with Markdown and they will now receive a well-formatted PDF from their developers. Important here is that the document looks good and professional.

Examples

Conversion of Demo.md toPDF,HTML,JPEG andPNG

Installation

Search in atom under Settings View -> Install -> Packages the package markdown-themeable-pdf and start the installation.

Configuration

...

Usage

The PDF can be generated in various ways:

  • Right-click in the editor area when a file is opened and select Markdown Print/Convert or
  • Right-click on a markdown file in Tree-View and select Markdown Print/Convert or
  • Press a shortcut in the editor area when a file is opened for
    • convert to PDF: ctrl-alt-p
    • convert to HTML: ctrl-alt-h
    • convert to Image: ctrl-alt-i (jpeg or png defined in package settings)

Page breaks

You can start any time a new PDF page with typing snippet/shortcode page-break or insert the HTML-Code <div class="page-break"></div> in your markdown editor. So you can prevent such ugly breaks in lists or other contiguous areas.

Custom CSS

The package creates a CSS file ~/.atom/markdown-themeable-pdf/styles.css in your atom configuration directory. You can use this file to customize everything. If you want to change the path, you can change it in the package settings. Alternatively, you can define with project-path/markdown-themeable-pdf/styles.css for each project its own CSS.

Tip: Export your markdown as HTML to inspect it in your favorite browser. After CSS changes you must not restart atom.

Contribute

Please do contribute! Issues and pull requests are welcome.

If you find this package useful, find errors, or have suggestions - please send me your feedback on GitHub - feel free to contribute. To develop the sources, start here.

Thank you for your help improving this software!

License

The MIT License (MIT)

About

ARCHIVED. NOT MAINTAINED. Themeable Markdown Converter (Print to PDF, HTML, JPEG or PNG)

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages