Skip to content

v1.0.0 — Templates, theming, and error checking

Choose a tag to compare

View all tags
@leonardosalasd leonardosalasd released this 17 Jun 01:22
· 55 commits to main since this release
v1.0.0
55e8919
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

First stable release! 🎉

doc-engine started as a quick way to turn a README into a decent-looking PDF, and it's grown enough that I'm finally comfortable calling it 1.0.

What's new

  • Five templates. Pick a look with --template: academic (the original), modern, minimal, technical, and book. Each one changes the fonts, layout, and cover page.
  • Accent colors. --accent recolors any template — pass a hex value like #7c3aed or a name like teal or rose.
  • Error checking. The CLI now scans your Markdown before compiling and points at the exact line and column of the problem — empty links, unclosed code fences, and so on. Run --dry-run to check a file without building a PDF. This came straight out of the suggestion in #1, thanks for that.
  • --no-branding hides the doc-engine footer if you'd rather leave it out.
  • info command that shows the version, repo, and available templates at a glance.

Other changes

  • Documented every flag in the README, plus a templates section and Docker usage.
  • Dropped some dead code and tidied up the internals.

Install

pipx install doc-engine-cli

Or run it with Docker:

docker run --rm -v "$PWD:/workspace" ghcr.io/leonardosalasd/doc-engine-cli build
Assets 2
Loading