Convert to GitHub Flavored Markdown
Format for converting from R Markdown to GitHub Flavored Markdown.
github_document( toc = FALSE, toc_depth = 3, fig_width = 7, fig_height = 5, dev = "png", df_print = "default", includes = NULL, md_extensions = NULL, hard_line_breaks = TRUE, pandoc_args = NULL, html_preview = TRUE, keep_html = FALSE )
TRUEto include a table of contents in the output
Depth of headers to include in table of contents
Default width (in inches) for figures
Default height (in inches) for figures
Graphics device to use for figure output (defaults to png)
Method to be used for printing data frames. Valid values include "default", "kable", "tibble", and "paged". The "default" method uses a corresponding S3 method of
print.data.frame. The "kable" method uses the
knitr::kablefunction. The "tibble" method uses the tibble package to print a summary of the data frame. The "paged" method creates a paginated HTML table (note that this method is only valid for formats that produce HTML). In addition to the named methods you can also pass an arbitrary function to be used for printing data frames. You can disable the
df_printbehavior entirely by setting the option
Named list of additional content to include within the document (typically created using the
Markdown extensions to be added or removed from the default definition or R Markdown. See the
rmarkdown_formatfor additional details.
TRUEto generate markdown that uses a simple newline to represent a line break (as opposed to two-spaces and a newline).
Additional command line options to pass to pandoc
TRUEto also generate an HTML file for the purpose of locally previewing what the document will look like on GitHub.
TRUEto keep the preview HTML file in the working directory. Default is
See the online
documentation for additional details on using the
R Markdown output format to pass to