https://github.com/hrbrmstr/markdowntemplates

:white_check_mark::small_red_triangle_down: A collection of alternate R markdown templates
https://github.com/hrbrmstr/markdowntemplates

markdown r rmarkdown rstats

Last synced: 5 days ago
JSON representation

:white_check_mark::small_red_triangle_down: A collection of alternate R markdown templates

• Host: GitHub
• URL: https://github.com/hrbrmstr/markdowntemplates
• Owner: hrbrmstr
• License: other
• Created: 2016-02-04T23:16:15.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-01-24T20:06:22.000Z (almost 6 years ago)
• Last Synced: 2024-12-31T07:12:22.358Z (12 days ago)
• Topics: markdown, r, rmarkdown, rstats
• Language: CSS
• Homepage:
• Size: 12.3 MB
• Stars: 318
• Watchers: 15
• Forks: 91
• Open Issues: 10
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - hrbrmstr/markdowntemplates - :white_check_mark::small_red_triangle_down: A collection of alternate R markdown templates (CSS)

README

        
---

output:

  html_document:

    keep_md: true

  md_document:

    variant: markdown_github

---

[![Build Status](https://travis-ci.org/hrbrmstr/markdowntemplates.svg)](https://travis-ci.org/hrbrmstr/markdowntemplates)

A package of R markdown templates and knitr knit engine replacments

These are a set of alternate R markdown templates that do not use Bootstrap and do not include or rely on jQuery. These are primarily here for demonstration purposes but are also useful in and of themselves (it's always good to have choices). If you have a particular framework you like and it's not here, file an issue and I'll add it.

- **bulma** (`output: markdowntemplates::bulma`) uses the [Bulma CSS framework](http://bulma.io) and has optional `navlink` YAML header elements and also has support for arbitrary footer content & a subset of OpenGraph tags (see the example Rmd) which will be used in header of the generated file.

- **skeleton** (`output: markdowntemplates::skeleton`) or **default** (`output: markdowntemplates::default`) uses the [Skeleton CSS framework](http://getskeleton.com) and has optional `navlink` YAML header elements and also has support for arbitrary footer content & a subset of OpenGraph tags (see the example Rmd) which will be used in header of the generated file.

- **kube** (`output: markdowntemplates::kube`) uses the [Kube CSS framework](https://imperavi.com/kube/) (contributed by Kieran Healy)

- **minimal** (`output: markdowntemplates::minimal`) uses no CSS framework and only uses the `title` YAML header element.

- **hugo** (`output: markdowntemplates::hugo`) produces markdown suitable for [Hugo](https://gohugo.io/) websites. It makes a broad assumption that you will save/use the `hugo` document in the `content` directory of your Hugo websites. 

- **prismpress** (`output: markdowntemplates::prismpress`) produces markdown suitable for use in WordPress with Jetpack (markdown-enabled) and Prism

- **prismskel** (`output: markdowntemplates::hrbrskel`) is a revamp of

the `skeleton` template that has top navbar and footer as optional, uses different

base colors, is Fira Sans/Fira Code-based and uses Prism for code highlighting

with a dark theme.

When you use RStudio to create a new R Markdown document, select "From Template" and choose one of these templates.

### knit engine replacements

- `to_jupyter()` : uses `notedown` to make an `ipynb` out of an Rmd

If you create an R markdown (Rmd) document with the following YAML header:

    ---

    knit: markdowntemplates::to_jupyter

    run: false

    ---

The `to_jupyter()` engine will be used and [`notedown`](https://github.com/aaren/notedown) will be used to convert the notebook to a Jupyter (ipynb) notebook. The `run` parameter is optional. If not present or set to `true` the notebook will be executed as it is converted to a Jupyter notebook. The engine is also now smart enough to detect the absence of pure R code chunks and avoid including of:

    %load_ext rpy2.ipython

    

at the top of the notebook.

### Installation

Since the package is not on CRAN yet, you have to install it devtools-style

```{r eval=FALSE}

devtools::install_git("https://sr.ht/~hrbrmstr/markdowntemplates")

# OR

devtools::install_git("https://gitlab.com/hrbrmstr/markdowntemplates")

# OR

devtools::install_github("hrbrmstr/markdowntemplates")

```

### Bulma example

![](./man/figures/bulma.png)

### Skeleton/default example

![](./man/figures/skeleton.png)

### Kube example

![](./man/figures/kube.png)

### Minimal example

![](./man/figures/minimal.png)