Github Flavored Markdown

Posted on 01-05-2021 by admin

Mar 10, 2021 Markdown is a formatting language that is created for the web. The purpose of markdown is to make life easy when we are writing on the internet. Over time there are many flavors of markdown created. But in this article, our focus will be mainly on Github Flavored Markdown (GFM). Github is based on CommonMark. There are a lot of additional. GitHub Flavored Markdown. View the source of this content. Let's get the whole 'linebreak' thing out of the way. The next paragraph contains two phrases separated by a single newline character: Roses are red Violets are blue. The next paragraph has the same phrases, but now they are separated by two spaces and a newline character: Roses are red. Remarkable is one of the best Markdown editors available for Linux. This article takes a detailed look at this tiny but awesome GitHub flavored Markdown editor. Markdown is a lightweight and simple Markup language. It allows you to create good looking documents using a plain text format.

Source: R/github_document.R

Format for converting from R Markdown to GitHub Flavored Markdown.

Arguments

toc	`TRUE` to include a table of contents in the output
toc_depth	Depth of headers to include in table of contents
number_sections	`TRUE` to number section headings
fig_width	Default width (in inches) for figures
fig_height	Default height (in inches) for figures
dev	Graphics device to use for figure output (defaults to png)
df_print	Method to be used for printing data frames. Valid valuesinclude 'default', 'kable', 'tibble', and 'paged'. The 'default' methoduses a corresponding S3 method of `print`, typically`print.data.frame`. The 'kable' method uses the`knitr::kable` function. The 'tibble' method usesthe tibble package to print a summary of the data frame. The 'paged'method creates a paginated HTML table (note that this method is only validfor formats that produce HTML). In addition to the named methods you canalso pass an arbitrary function to be used for printing data frames. Youcan disable the `df_print` behavior entirely by setting the option`rmarkdown.df_print` to `FALSE`. SeeDataframe printing section in bookdown book for examples.
includes	Named list of additional content to include within thedocument (typically created using the `includes` function).
md_extensions	Markdown extensions to be added or removed from thedefault definition or R Markdown. See the `rmarkdown_format` foradditional details.
hard_line_breaks	`TRUE` to generate markdown that uses a simplenewline to represent a line break (as opposed to two-spaces and a newline).
pandoc_args	Additional command line options to pass to pandoc
html_preview	`TRUE` to also generate an HTML file for the purpose oflocally previewing what the document will look like on GitHub.
keep_html	`TRUE` to keep the preview HTML file in the workingdirectory. Default is `FALSE`.

Value

R Markdown output format to pass to render