|
| 1 | +# TAGLINE |
| 2 | + |
| 3 | +Zero-config Markdown to PDF documentation engine using Typst |
| 4 | + |
| 5 | +# TLDR |
| 6 | + |
| 7 | +**Generate a PDF** from README.md with zero configuration |
| 8 | + |
| 9 | +```doc-engine build``` |
| 10 | + |
| 11 | +**Convert a specific file** and override title and author |
| 12 | + |
| 13 | +```doc-engine build CONTRIBUTING.md -o guide.pdf -t "Guide" -a "Team"``` |
| 14 | + |
| 15 | +**Use a different template** and accent color |
| 16 | + |
| 17 | +```doc-engine build --template modern --accent teal``` |
| 18 | + |
| 19 | +**Check for Markdown errors** without generating PDF |
| 20 | + |
| 21 | +```doc-engine build --dry-run``` |
| 22 | + |
| 23 | +**Install via pipx** |
| 24 | + |
| 25 | +```pipx install doc-engine-cli``` |
| 26 | + |
| 27 | +# SYNOPSIS |
| 28 | + |
| 29 | +**doc-engine** build [INPUT_FILE] [options] |
| 30 | + |
| 31 | +**doc-engine** info |
| 32 | + |
| 33 | +**doc-engine** --help | --version |
| 34 | + |
| 35 | +# DESCRIPTION |
| 36 | + |
| 37 | +**doc-engine** is a CLI tool that converts Markdown files into professionally styled PDF documents using Typst as the rendering backend. It auto-detects README.md, extracts metadata from Git, and produces high-quality technical or academic reports complete with cover page, table of contents, and syntax-highlighted code. |
| 38 | + |
| 39 | +It requires no LaTeX, Pandoc, or manual configuration. The tool supports five built-in templates and custom accent colors. It can also perform source error checking with precise line/column reporting. |
| 40 | + |
| 41 | +# PARAMETERS |
| 42 | + |
| 43 | +**build** [_INPUT_FILE_] |
| 44 | + |
| 45 | +> Convert the Markdown file to PDF. Defaults to auto-detecting README.md in the current directory. |
| 46 | +
|
| 47 | +**-o**, **--output** _file.pdf_ |
| 48 | + |
| 49 | +> Output file path. Default: <input>_doc.pdf |
| 50 | +
|
| 51 | +**-t**, **--title** _title_ |
| 52 | + |
| 53 | +> Document title. Defaults to first # heading or Git-derived. |
| 54 | +
|
| 55 | +**-a**, **--author** _name_ |
| 56 | + |
| 57 | +> Author name. Defaults to `git config user.name`. |
| 58 | +
|
| 59 | +**--template** _name_ |
| 60 | + |
| 61 | +> Template: academic (default), modern, minimal, technical, book. |
| 62 | +
|
| 63 | +**--accent** _color_ |
| 64 | + |
| 65 | +> Accent color (hex or named: blue, teal, rose, etc.). |
| 66 | +
|
| 67 | +**--bib** _file.bib_ |
| 68 | + |
| 69 | +> Bibliography file for IEEE-style references section. |
| 70 | +
|
| 71 | +**--dry-run** |
| 72 | + |
| 73 | +> Validate Markdown and report errors without producing PDF. |
| 74 | +
|
| 75 | +**--open** |
| 76 | + |
| 77 | +> Open the generated PDF after creation. |
| 78 | +
|
| 79 | +**--no-branding** |
| 80 | + |
| 81 | +> Omit "doc-engine" attribution from footer. |
| 82 | +
|
| 83 | +# EXAMPLES |
| 84 | + |
| 85 | +Basic zero-config usage in a project directory: |
| 86 | + |
| 87 | +```doc-engine build``` |
| 88 | + |
| 89 | +Generate with custom options: |
| 90 | + |
| 91 | +```doc-engine build docs/api.md -o api.pdf --template technical --accent "#7c3aed"``` |
| 92 | + |
| 93 | +# CAVEATS |
| 94 | + |
| 95 | +Images in Markdown are rendered only as alt text (remote images not downloaded or embedded). Complex layouts may require reviewing the output PDF. Requires Python 3.10+ and the Typst Python bindings (installed automatically). |
| 96 | + |
| 97 | +# SEE ALSO |
| 98 | + |
| 99 | +[typst](/man/typst)(1), [pandoc](/man/pandoc)(1), [weasyprint](/man/weasyprint)(1) |
| 100 | + |
| 101 | +# RESOURCES |
| 102 | + |
| 103 | +```[Source code](https://github.com/leonardosalasd/doc-engine-cli)``` |
| 104 | + |
| 105 | +```[Documentation](https://github.com/leonardosalasd/doc-engine-cli#readme)``` |
| 106 | + |
| 107 | +<!-- verified: 2026-07-07 --> |
0 commit comments