aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorkj_sh6042026-03-11 22:32:11 -0400
committerkj_sh6042026-03-11 22:32:11 -0400
commitd151ec91488f10134babae4d4a879d823b221b62 (patch)
tree8b9cf53f596e29f2400339a9bc4357763eaf62e5 /README.md
parentbee95cc07ab1e68fb1aee42a42d5bc01e039f883 (diff)
refactor: re-write in a fmailiar language to make it easier to maintain
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/README.md b/README.md
index de613e8..7d7a087 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,21 @@
# likha-pdf
-a simple and crappy web app that converts markdown to pdf using pandoc and lualatex.
+a simple web app that converts markdown to pdf.
<img width="1440" height="1080" alt="likha-pdf screenshot" src="https://github.com/user-attachments/assets/9fa15803-f0da-43d0-8a82-0fc490f3d5ff" />
## features
- markdown to pdf export
-- crappy image upload (but it works)
-- emoji-capable latex template
+- image upload with markdown snippet insertion
+- paper size, margin, font, line spacing, and page number options
+- syntax-highlighted code blocks
+- always produces a pdf (reportlab fallback if weasyprint fails)
## requirements
-- nim 1.6+
-- pandoc
-- lualatex
+- python 3.10+
+- system packages: `libcairo2 libpango-1.0-0 libpangocairo-1.0-0 libgdk-pixbuf2.0-0 shared-mime-info`
## image usage
@@ -28,9 +29,9 @@ a simple and crappy web app that converts markdown to pdf using pandoc and luala
### local
```bash
+pip install -r requirements.txt
cd src/
-nim c -d:release -o:likha-pdf app.nim
-./likha-pdf
+python3 app.py
```
### docker
@@ -40,4 +41,4 @@ docker build -t likha-pdf .
docker run -p 5001:5001 likha-pdf
```
-open `http://localhost:5000`
+open `http://localhost:5001`