https://github.com/leroycep/mdproof

A standalone markdown to PDF converter
https://github.com/leroycep/mdproof

markdown markdown-to-pdf

Last synced: 3 months ago
JSON representation

A standalone markdown to PDF converter

• Host: GitHub
• URL: https://github.com/leroycep/mdproof
• Owner: leroycep
• Created: 2018-09-10T23:49:15.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-26T14:58:00.000Z (about 1 year ago)
• Last Synced: 2024-06-21T11:30:43.828Z (5 months ago)
• Topics: markdown, markdown-to-pdf
• Language: Rust
• Size: 1.15 MB
• Stars: 179
• Watchers: 7
• Forks: 4
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome-starred - leroycep/mdproof - A standalone markdown to PDF converter (markdown)

README

        
# `mdproof`

A command line program that generates PDFs from markdown files, with no

dependency on LaTeX or a headless browser. Still a work in progress,

use at your own risk.

## Features

- No dependency on LaTeX or any other executable

- Lists, code blocks, regular text, bold text, and italic text!

    - The complete commonmark spec is [still being implemented][]!

[still being implemented]: https://github.com/Geemili/mdproof/issues/1

## Screenshots

![The readme rendered as a PDF](images/readme-pdf.png)

## Installation

```bash

$ git clone https://github.com/Geemili/mdproof

$ cd mdproof

$ cargo build

```

## Usage

```bash

$ cargo run README.md

$

$ # Or if you've copied `mdproof` to your `~/bin` folder

$ mdproof README.md

```

## Why?

There are already a plethora of ways to generate PDFs, including LaTeX, headless

browsers, or libreoffice. However, all of these methods pull in massive

dependencies, and can be difficult to set up correctly.

By comparison, this program relies on only a few (direct) dependencies, and can

be compiled into a single executable file.

The goal of this program is to compile markdown to pdf, without stepping through

dependency hell.