Skip to content

RobertoPorpora/Markdowncuments

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Logo

MarkDowncuments

📝 Markdown Documents to PDF Documents conversion tool.
Runs on Windows, MacOS and Linux.

Report Bug · Request Feature · Support Project

About

MarkDowncuments is designed to be your go-to tool for effortlessly transforming Markdown files into beautifully formatted PDF documents.

Example screenshot

(back to top)

Key Highlights

  • Ease of Use: Just drop the executable into the directory housing your Markdown files and watch the magic unfold in a few seconds with a simple execution.
  • Batch Conversion: MarkDowncuments effortlessly scans through all Markdown files in the folder from which it is executed, producing corresponding PDFs with ease.
  • Automatic Enhancement: Basic styling enhancements are applied to the PDFs. Enjoy colored titles, meticulously crafted pagination, and other subtle yet impactful visual enhancements.
  • Page Breaks: Use context breaks "***" as page breaks.
  • Versatile Functionality: Whether you're online or offline, MarkDowncuments delivers. When connected to the web, mathematical formulas are elegantly rendered using MathJax.

(back to top)

Prerequisite

The system using MarkDowncuments must have Google Chrome or Chromium installed.

(back to top)

For Developers

  • Prerequisites: Rust and Cargo must be installed. The build script is in Python (so you should have Python installed too...).
  • Dependencies:
    • anyhow
    • comrak
    • headless-chrome
  • Build Script: The build script 'build.py' is in Python, so just run python build.py to build the project. The executable output directory is 'dist'.
  • Customization: To customize the visual style, modify the HTML and CSS files located in "src/html_wrapper".

(back to top)

Next developments

  • Options for header title and date
  • Options for footer page numbering
  • Fix error handling, notifying the user either with an action to take or providing a message that helps understand where and why the error occurred.
  • Remove dependency on the Chromium browser.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published