Creating Pretty Documents from R Markdown
Creating tiny yet beautiful documents and vignettes from R
Markdown. The package provides the 'html_pretty' output format as an
alternative to the 'html_document' and 'html_vignette' engines that
convert R Markdown into HTML pages. Various themes and syntax highlight
styles are supported.
Creating Pretty Documents From R Markdown
Have you ever tried to find a lightweight yet nice theme for the R Markdown documents, like this page?
Themes for R Markdown
With the powerful rmarkdown package, we could easily create nice HTML document by adding some meta information in the header, for example
--- title: Nineteen Years Later author: Harry Potter date: July 31, 2016 output: rmarkdown::html_document: theme: lumen ---
The html_document engine uses the Bootswatch theme library to support different styles of the document. This is a quick and easy way to tune the appearance of your document, yet with the price of a large file size (> 700KB) since the whole Bootstrap library needs to be packed in.
For package vignettes, we can use the
engine to generate a more lightweight HTML file that is meant to minimize the
package size, but the output HTML is less stylish than the
So can we do BOTH, a lightweight yet nice-looking theme for R Markdown?
The prettydoc Engine
The answer is YES! (At least towards that direction)
The prettydoc package provides an alternative engine,
to knit your R Markdown document into pretty HTML pages.
Its usage is extremely easy: simply replace the
rmarkdown::html_vignette output engine by
prettydoc::html_pretty in your R Markdown header, and use one of the built-in
themes and syntax highlighters. For example
--- title: Nineteen Years Later author: Harry Potter date: July 31, 2016 output: prettydoc::html_pretty: theme: cayman highlight: github ---
You can also create documents from prettydoc templates in RStudio.
Step 1: Click the "New File" button and choose "R Markdown".
Step 2: In the "From Template" tab, choose one of the built-in templates.
Options and Themes
The options for the
html_pretty engine are mostly compatible with the default
(see the documentation)
with a few exceptions:
- Currently the
themeoption can take the following values. More themes will be added in the future.
highlightoption takes value from
- A new
mathparameter to choose between
katexfor rendering math expressions. The
katexoption supports offline display when there is no internet connection.
toc_floatare not applicable.
Offline Math Expressions
html_pretty uses MathJax to render math expressions. However, using MathJax
requires an internet connection. If you need to create documents that can
show math expressions offline, simply add one line
math: katex to the document metadata:
--- title: Nineteen Years Later author: Harry Potter date: July 31, 2016 output: prettydoc::html_pretty: theme: cayman highlight: github math: katex ---
This option will enable KaTeX for rendering the math expressions, and all resource files will be included in for offline viewing. The offline document will be ~800k larger.
- tufte provides the Tufte style for R Markdown documents.
- BiocStyle provides standard formatting styles for Bioconductor PDF and HTML documents.
- rmdformats by Julien Barnier contains HTML formats and templates for R Markdown documents, with some extra features such as automatic table of contents, lightboxed figures, and dynamic crosstab helper.
- markdowntemplates by Bob Rudis is a collection of alternative R Markdown templates.
- prettyjekyll by Florian Privé uses prettydoc to convert R Markdown documents to Jekyll Markdown for blog posting.
Here are some screenshots of the HTML pages generated by prettydoc with different themes and syntax highlighters.
Cayman (demo page)
Tactile (demo page)
Architect (demo page)
Leonids (demo page)
HPSTR (demo page)
Functions in prettydoc
|html_pretty||Creating Pretty HTML from R Markdown|
Vignettes of prettydoc
Last month downloads
|SystemRequirements||pandoc (>= 1.12.3)|
|License||Apache License (>= 2.0)|
|Packaged||2019-11-22 19:23:51 UTC; qyx|
|Date/Publication||2019-11-23 06:20:25 UTC|
Include our badge in your README