inst/templates/fact_sheet_pdf_instructions.md

In UrbanInstitute/urbntemplates: Contains templates for the Urban Institute

Instructions

pdf fact sheets

fact_sheet_pdf.Rmd and its associated files create a branded .html fact sheets.

Included files and documents

• fact_sheet_pdf.Rmd
• .gitignore
• fact_sheet_preamble.tex
• iterate.R

Adding content

PDF fact sheets slides can contain text formatted with Markdown, analytic code, and code output such as tables and plots. Code can be included in "code chunks". Code chunks look like this:

{r chunk-name} 1 + 1

To learn more about Markdown visit: https://daringfireball.net/projects/markdown/syntax

To learn more about R Markdown visit here: https://rmarkdown.rstudio.com/

Formatting of the fact sheets is mostly handled with special LaTeX macros created at the Urban Institute. This repository contains information about the macros.

Iteration

This blog contains thorough instructions for iterating html fact sheets with R.

Web hosting

Fact sheets can be hosted online for free using GitHub pages. It is simplest to rename template.Rmd to index.Rmd and then knit the document into index.html. Add index.html to the top directory or a new directory called docs/, and then push the content to the master repository on GitHub. Go to settings and follow the prompts under GitHub pages to set up the web hosting.

It is typically useful to copy the generated link to the content and paste it in the website field at the top of the front page of the repository.

UrbanInstitute/urbntemplates documentation built on April 27, 2022, 4:35 a.m.