{"id":13511202,"url":"https://github.com/aaronwolen/pandoc-letter","last_synced_at":"2025-04-05T03:09:29.884Z","repository":{"id":12362332,"uuid":"15011229","full_name":"aaronwolen/pandoc-letter","owner":"aaronwolen","description":"Pandoc template for writing letters in markdown","archived":false,"fork":false,"pushed_at":"2023-06-25T09:45:04.000Z","size":248,"stargazers_count":422,"open_issues_count":12,"forks_count":121,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-29T02:05:22.874Z","etag":null,"topics":["latex-template","letter","markdown","pandoc","tex"],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aaronwolen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2013-12-07T19:08:28.000Z","updated_at":"2025-03-27T06:18:43.000Z","dependencies_parsed_at":"2024-01-13T21:46:20.658Z","dependency_job_id":null,"html_url":"https://github.com/aaronwolen/pandoc-letter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronwolen%2Fpandoc-letter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronwolen%2Fpandoc-letter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronwolen%2Fpandoc-letter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaronwolen%2Fpandoc-letter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aaronwolen","download_url":"https://codeload.github.com/aaronwolen/pandoc-letter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247280272,"owners_count":20912967,"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":["latex-template","letter","markdown","pandoc","tex"],"created_at":"2024-08-01T03:00:37.924Z","updated_at":"2025-04-05T03:09:29.866Z","avatar_url":"https://github.com/aaronwolen.png","language":"TeX","funding_links":[],"categories":["Pandoc Templates","TeX","Popular \u0026 New Non-LaTeX Templates"],"sub_categories":["Others"],"readme":"# A simple letter template for Pandoc\n\n[![Build Status](https://travis-ci.org/aaronwolen/pandoc-letter.svg?branch=master)](https://travis-ci.org/aaronwolen/pandoc-letter)\n[![Package-License](http://img.shields.io/badge/license-GPL--3-brightgreen.svg?style=flat)](http://www.gnu.org/licenses/gpl-3.0.html)\n\n**Authors**: [Aaron Wolen][aaron] and [Andrew Dunning][andrew]\n\nThis template allows you to write letters in Markdown and convert them to nice looking PDFs using [Pandoc][] and [LaTeX][]. It accepts arguments used in the LaTeX letter class, including:\n\n* opening\n* closing\n* address\n* return-address\n* postscript\n* enclosures list\n* carbon-copy list\n\nAll of which can be specified in a YAML metadata block. Additional [Pandoc/LaTex options][pandoc-latex-variables] can be configured directly in the metadata block. For example:\n\n```yaml\n---\nauthor: Aaron\nopening: To whom it may concern,\nclosing: Sincerely,\naddress:\n- 123 Street Rd\n- Chicago, IL\nreturn-address:\n- My Home\n- 456 Road St.\n- New York, NY\n\n# ADDITIONAL ARGUMENTS\nlinks-as-notes: true\n...\n```\n\nNote that each address component should start with a hyphen. The provided example letter can be compiled with the following command:\n\n```shell\npandoc --template=template-letter.tex example/letter.md -o example/letter.pdf\n```\n\nYou can see the PDF output [here](https://github.com/aaronwolen/pandoc-letter/blob/master/example/letter.pdf).\n\n## Features\n\nThe following can be set either as variables when executing `pandoc` or added to the YAML metadata.\n\n`address`\n:   Name and address of the recipient; takes a list for a multi-line address.\n\n`subject`\n:   Subject of the letter.\n\n`author`\n:   Writer of the letter; can take a list for a multi-line signature.\n\n`blockquote`\n:   Changes style of block quotations to match [bootstrap][] (requires the [mdframed][] package).\n\n`cc`\n:   Recipients to be carbon-copied; can take a list for multiple recipients.\n\n`closing`\n:   Text for the complementary close.\n\n`closing-indentation`\n:   Amount for closing signature block to be intended from left margin.\n\n`date`\n:   Custom date (current date will be automatically inserted if not specified).\n\n`encl`\n:   List of enclosures.\n\n`letterhead`\n:   Image file to be used as letterhead (requires the [wallpaper][] package), applied only to the first page.\n\n`opening`\n:   Text for the salutation.\n\n`ps`\n:   Text to be added at the end of the letter as a postscript.\n\n`return-address`\n:   Address of the sender: takes a list to allow a multi-line address.\n\n`signature`\n:   Image file for a signature.\n\n`signature-before`, `signature-after`\n:   Allows adjustment of vertical space surrounding signature.\n\n`signature-width`\n:   Specify width of signature image file.\n\n## Running with Docker\n\nThis requires [Docker](https://www.docker.com/products/docker-desktop) to be installed. \n\nAfter cloning the repository build the container. `cd` to the cloned directory and run \n\n``` \n  docker build --tag=pandoc-letter .\n```\n\nThis has to be executed only once per machine.\n\nTo create a letter run \n\n```\n    docker run --volume \u003cpath_to_folder_with_letter.md\u003e:/data pandoc-letter --template=template-letter.tex letter.md -o letter.pdf\n```\n\nMake sure you insert the full folder path where `letter.md` resides.\n\n### Images, Attachments\n\nTo insert an image into the body of your letter:\n\n```\n![](lalune.jpg){ width=50% }\n```\n\nThe curly brackets are optional.  This inserts the image into the\nlocation of the command, above the signature.\n\nThe recommended way to attach images on a new page after the signature\nis to compile a separate pdf file by other means than pandoc-letter,\nand then attach the two pdf files with whatever utilities you are\nfamiliar with.\n\n\n## License\n\nGPL-3 for pandoc-letter and the underlying [Pandoc template][latex-template].\n\n[bootstrap]: http://getbootstrap.com/css/#type-blockquotes\n[latex]: http://www.latex-project.org/\n[latex-template]: https://github.com/jgm/pandoc-templates/blob/master/default.latex\n[pandoc]: http://pandoc.org\n[wallpaper]: https://www.ctan.org/pkg/wallpaper\n[mdframed]: https://www.ctan.org/pkg/mdframed\n[pandoc-latex-variables]: http://pandoc.org/MANUAL.html#variables-for-latex\n[aaron]: http://aaronwolen.com\n[andrew]: http://andrewdunning.ca\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaronwolen%2Fpandoc-letter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faaronwolen%2Fpandoc-letter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaronwolen%2Fpandoc-letter/lists"}