{"id":13859107,"url":"https://github.com/rnuske/komaletter","last_synced_at":"2025-04-13T06:37:13.189Z","repository":{"id":44901862,"uuid":"126045918","full_name":"rnuske/komaletter","owner":"rnuske","description":"R package for comfortable writing of beautiful PDF letters in Markdown.","archived":false,"fork":false,"pushed_at":"2024-06-10T13:55:18.000Z","size":9408,"stargazers_count":86,"open_issues_count":2,"forks_count":21,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-24T10:42:30.796Z","etag":null,"topics":["koma-script","latex","letter","markdown","pandoc","pandoc-letter","pdf","r","r-package"],"latest_commit_sha":null,"homepage":"https://rnuske.github.io/komaletter","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rnuske.png","metadata":{"files":{"readme":"README.md","changelog":"NEWS.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-20T16:11:01.000Z","updated_at":"2025-03-22T08:13:58.000Z","dependencies_parsed_at":"2022-08-21T05:50:13.072Z","dependency_job_id":"20d1b788-4ee0-4c06-aebf-05fd667f5e39","html_url":"https://github.com/rnuske/komaletter","commit_stats":{"total_commits":110,"total_committers":5,"mean_commits":22.0,"dds":0.09999999999999998,"last_synced_commit":"4bbd04aaf0a1f5325f442dffe60e7a7003fe52d8"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rnuske%2Fkomaletter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rnuske%2Fkomaletter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rnuske%2Fkomaletter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rnuske%2Fkomaletter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rnuske","download_url":"https://codeload.github.com/rnuske/komaletter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248675334,"owners_count":21143763,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["koma-script","latex","letter","markdown","pandoc","pandoc-letter","pdf","r","r-package"],"created_at":"2024-08-05T03:02:33.101Z","updated_at":"2025-04-13T06:37:13.167Z","avatar_url":"https://github.com/rnuske.png","language":"TeX","funding_links":[],"categories":["TeX"],"sub_categories":[],"readme":"# komaletter: Simply Beautiful PDF Letters from Markdown  \u003ca href=\"https://rnuske.github.io/komaletter/\"\u003e\u003cimg src=\"man/figures/logo.png\" align=\"right\" height=\"139\" /\u003e\u003c/a\u003e\n\n\u003c!-- badges: start --\u003e\n[![R-CMD-check](https://github.com/rnuske/komaletter/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rnuske/komaletter/actions/workflows/R-CMD-check.yaml)\n[![Package-License](https://img.shields.io/badge/license-GPL--3-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-3.0.html) \n[![CRAN](https://www.r-pkg.org/badges/version/komaletter)](https://cran.r-project.org/package=komaletter) \n[![Dependencies](https://tinyverse.netlify.app/badge/komaletter)](https://cran.r-project.org/package=komaletter) \n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1221316.svg)](https://doi.org/10.5281/zenodo.1221316)\n\u003c!-- badges: end --\u003e\n\n\n### Motivation\nSimple letters tend to look very much alike. They are either determined by a \nstandard eg. window envelope style or writer's preferences. Since the layout \nis fixed, letters can be written perfectly in R Markdown.\n\nThe [KOMA-Script LaTeX Bundle](https://www.komascript.de) provides layouts for\nmany common window envelope types (German, US, French, Japanese, ...) and the\npossibility to define your own layout. The *komaletter* package also provides\nit's own default letter layout loosely based on DIN 5008B.\n\nThis package is an adaptation of the\n[linl](https://cran.r-project.org/package=linl) package\nfor international writers. linl itself is based on the\n[pandoc-letter](https://github.com/aaronwolen/pandoc-letter) \ntemplate and extends it for use from R via the\n[rmarkdown](https://cran.r-project.org/package=rmarkdown) package.\n\n\n### Examples\n\n#### Skeleton\nThe skeleton provided by `komaletter` creates a very simple letter as a \nstarting point for your own writing. Several formatting defaults such as font, \nfontsize, indentation are in use. See `vignette('intro', 'komaletter')` and \n`help(komaletter)` for a complete list and their default values. The following \nfigure shows the `rmarkdown` source on the left and the rendered `pdf` on the\nright.\n\n![](man/figures/skeleton.png)\n\n\n#### Vignette\nThe vignette examples are a bit more detailed and s demonstrate, for example, \nhow to include a signature, choose a different layout and make some format \nsettings. All of these are driven by simple settings in the `YAML` header as \nshown in the following figure on the left.\n\n![](man/figures/letter_example1.png)\n\n\n### Usage\nTo start a new letter you can take advantage of the komaletter skeleton via \n`rmarkdown::draft()` or the RStudio menu: File \u003e New File \u003e R Markdown... \u003e \nFrom Template \u003e komaletter (PDF). \nWhen finished writing your letter the RMarkdown document can be rendered to PDF\nvia `rmarkdown::render()` or the RStudio Knit button.\n\n```r\n# start a new letter using the provided skeleton\nrmarkdown::draft(\"my_letter.Rmd\", template=\"pdf\", package=\"komaletter\", edit=FALSE)\n\n# change my_letter.Rmd to your liking\n\n# turn Rmd into a beautiful PDF\nrmarkdown::render(\"my_letter.Rmd\")\n```\n\n\n### About Printing\nSome PDF viewers do not realize that the document already has a blank margin and scale or 'fit to page' for printing. This generally results in smaller fonts, overly large margins, broken layout and most importantly a misplaced address. In the worst case, parts of the address are not visible in the window of the envelope.\n\nkomaletter's default layout signals the PDF viewer to print the document at its actual size. Unfortunately, not many PDF viewers heed this hint. \n\nThus, before printing the document, you should check that the document is not shrunk or 'fit to page'. **The document must be printed at its actual size / 100%** so that the positions of the elements are correct.\n\n\n### Installation\nYou can install the released version of **komaletter** from [CRAN](https://CRAN.R-project.org/package=komaletter) with\n\n``` r\ninstall.packages(\"komaletter\")\n```\n\nand the development version from [GitHub](https://github.com/rnuske/komaletter) \nusing the package `remotes`\n\n``` r\nremotes::install_github(\"rnuske/komaletter\")\n```\n\n\n### Requirements\nBeyond the R package dependency `rmarkdown`, a working `pandoc` binary and a\n`LaTeX` distribution including `KOMA-Script` is needed. RStudio installs it's\nown copy of `pandoc`, otherwise do what is needed on your OS. As for LaTeX look\nfor `texlive` which is included in most Linux distributions. KOMA-Script is\npart of all but the most bare bone LaTeX distributions. Something like \n`sudo apt install pandoc pandoc-citeproc texlive` should provide everything \nneeded on Debian/Ubuntu. To get a working LaTeX on Windows it is recommended \nto use the service of the R package `tinytex`.\n\nIf you plan to write non-english letters, make sure you have the necessary \nlanguage packs, _i.e._ `texlive-lang-german`.\n\n\n### Authors\nRobert Nuske, Dirk Eddelbuettel and Aaron Wolen.\n\n\n### License\nGPL-3 for this package, the work in [pandoc-letter](https://github.com/aaronwolen/pandoc-letter), as well as the underlying Pandoc template.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frnuske%2Fkomaletter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frnuske%2Fkomaletter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frnuske%2Fkomaletter/lists"}