remarquee upload — getting started

Documentation index for Remarquee v0.0.8, with 12 sections.

Sections

Terminology & Glossary
📖 Documentation
Navigation
12 sectionsv0.1
📄 remarquee upload — getting started — glaze help remarquee-upload-getting-started
remarquee-upload-getting-started

remarquee upload — getting started

Topic

Goal

Upload Markdown to a reMarkable device as a PDF.

remarquee upload md is the write path for documentation workflows:

  • Markdown → PDF via pandoc + xelatex (DejaVu fonts)
  • Upload via rmapi (in-process, no shelling out)
  • Default destination: /ai/YYYY/MM/DD/ (today)
  • Safe by default: skips existing documents unless --force

Quick start

go run ./cmd/remarquee upload md --dry-run /abs/path/to/doc.md

2) Upload (no overwrite)

go run ./cmd/remarquee upload md /abs/path/to/doc.md

3) Upload a directory (recursive)

go run ./cmd/remarquee upload md --dry-run /abs/path/to/dir/
go run ./cmd/remarquee upload md /abs/path/to/dir/

Common flags

  • --date YYYY/MM/DD / YYYY-MM-DD: uploads to /ai/YYYY/MM/DD/
  • --remote-dir /Some/Folder: override destination directory entirely
  • --pdf-only --output-dir ./out: generate PDFs locally, do not upload
  • --force: overwrite existing documents (deletes existing document and annotations)

Dependencies

  • pandoc must be installed and on PATH (or pass --pandoc)
  • xelatex must be available (TeX Live)
  • fonts: DejaVu Sans / DejaVu Sans Mono (defaults; override with flags)