readthedown

A modified readthedown theme that offers out-of-box template with predefined styles, and configurations. It is greatly inspired and modified based on juba/rmdformats package

Quick Start

Install template package

devtools::install_github("6chaoran/readthedown")

Create Rmarkdown from template

RStudio > File > New File > R Markdown ... > From Template

Added features

1. logo options are added both inside the sidebar (logo) and main content (logo2)
2. favicon option is added
3. author avatar option is added
4. colored block quote to differentiate level of attention
5. multiple columns layout to display content side by side
6. fixed css style of details & summary

Cutsomize the template

Modify the style.css to further customize the markdown template

Credits

• rmdformats markdown template
• Magnific popup lightbox plugin
• The CSS for the html_docco format is heavily inspired from the default one of the docco project.
• The CSS and JavaScript for readthedown is adapted from the corresponding readtheorg theme of the org-html-themes project, which is itself inspired by the Read the docs Sphinx theme.
• The CSS and JavaScript for material has been taken from the Material design theme for Bootstrap 3 project and its presentation page.
• The CSS for robobook is directly derived from the bookdown project template.
• The CSS for downcute is directly derived from the default theme of the docute project and its adaptation by John Coene for some of its projects documentation.
• The downcute chaos theme has been created by Zac Garland.
• JavaScript and HTML code for code folding and tabbed sections are taken from the RStudio's default rmarkdown HTML template.
• The html_clean styling and features are very similar to the ones from the knitrBootstrap package by Jim Hester.