https://github.com/vectorface/docbuilder

A Markdown To PDF Documentation Generation Tool
https://github.com/vectorface/docbuilder

Last synced: about 1 month ago
JSON representation

A Markdown To PDF Documentation Generation Tool

• Host: GitHub
• URL: https://github.com/vectorface/docbuilder
• Owner: Vectorface
• License: mit
• Created: 2015-06-29T17:43:25.000Z (over 9 years ago)
• Default Branch: dev
• Last Pushed: 2024-04-22T16:28:33.000Z (10 months ago)
• Last Synced: 2024-04-23T17:36:31.587Z (10 months ago)
• Language: PHP
• Size: 39.1 KB
• Stars: 0
• Watchers: 11
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docbuilder

docbuilder is a simple tool that allows you to generate PDF documentation from markdown & css.

This tool generates pdfs through intermediary HTML that can be styled with custom CSS rules (see usage).

## Requirements

* PHP >= 7.4

* mbstring

* gd (for image support)

* zlib

## Installation

```shell

$ git clone https://github.com/Vectorface/docbuilder.git

$ cd docbuilder

$ composer update

```

## Usage

```shell

$ ./bin/docbuilder -h

Usage: docbuilder [OPTION]... [INFILE] [OUTFILE]

Converts Markdown files to pdf.

Options:

  -c, --css=FILE   provide css file for styling (overrides default styling)

  -p, --printhtml  output intermediate html file (accepts optional filename argument)

  -h, --help       display this help and exit

  -v, --version    output version number and exit

```

## Build Phar

A standalone .phar archive can be built with [box](https://github.com/box-project/box2 "Box Project").