hrbrmstr / markdowntemplates Goto Github PK

View Code? Open in Web Editor NEW

318.0 15.0 92.0 12.55 MB

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

License: Other

R 7.08% HTML 13.46% CSS 69.42% JavaScript 10.04%

r rstats markdown rmarkdown

markdowntemplates's Introduction

output

html_document

md_document

keep_md
true

variant
markdown_github

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 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 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 (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 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 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

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

Skeleton/default example

Kube example

Minimal example

markdowntemplates's People

Contributors

Stargazers

Watchers

Forkers

jankatins kjhealy lejarx dtharvey bjcochrane triharder ikuyasu gragusa robertadams napaxton usgs-r sthossain eselopio badfocus radovankavicky gapdata asalihsimsek raviolli77 emilelatour mehmetaergun aespar21 tim113 nicknau tungttnguyen guillaumepressiat connorbitter adglow-ahuertam andreaangeli jkassof-rock boshek anishsingh20 bingles cmhealgt neilchalk desautm lfpdroubi ytlogos kashenfelter phuchonguyen eupimenta pkq rodmorley jcopperman em1729 lencripe puneet988 ines-ana frank-sw kmaheshkulkarni webbedfeet cneskey davan690 dosputin fanghuiz georgegui hfshr shotchki daghjermann sachadrousie alex33261 svensson-martin pzhaonet gamachisgurmesa oxb-dc drroad stendieden aarjav1997 justtryintolive jimsforks lenamax2355 eframp ocumetra erge324 plantaclaus amirmasoudabdol alanzchen mnzhu16 zyuan3 matt-d-b

markdowntemplates's Issues

CRAN release?

I'm hoping to write a post for the RStudio blog soon about custom R Markdown formats and as part of that want to point to formats currently available on CRAN (may even to do a "gallery" page on rmarkdown.rstudio.com). Do you think these formats will hit CRAN soon so I can include them?

Color code chunks

Hello, good afternoon / evening. I would like to know if there is any way in which the code chunks can have different colors in the "skeleton" template, since there all the codes look gray and I would like something more pleasant to look at.

Thanks for reading me

Possible new github_document variant

Surprisingly, pandoc's line endings vary based upon the OS it's running under (jgm/pandoc#2097). This causes me some grief as I try to keep my docs using UNIX. This could be addressed by wrapping the existing github_document template with a post_processor that calls dos2unix (or some more universal solution for Windows OS).

Would you like a PR to add such a template or does that make sense in a different repo? I know your feelings on Windows. 😃

Can't install package

Can't install:

> install.packages("markdowntemplates")
Installing package into ‘D:/Users/geo_gusc/Documents/R/win-library/3.2’ (as ‘lib’ is unspecified)
Warning in install.packages :
  package ‘markdowntemplates’ is not available (for R version 3.2.3)

Here my sessioninfo:

> sessionInfo()
R version 3.2.3 (2015-12-10)
Platform: x86_64-w64-mingw32/x64 (64-bit)
Running under: Windows 7 x64 (build 7601) Service Pack 1

[Questions] When creating Rmd from template, YAML title field is not populated with entered title

…instead, the file is placed in a folder named after the entered title.
I get that this might me intended behavior, however, "normal" Rmd documents behave differently, and I feel it would be more adequate to mimic that behavior (i.e. creating a file with entered name and title: in the working directory, since the template only produces a single HTML file anyway, thereby I don't see the need for an enclosing folder.

Thoughts?

self_contained=FALSE unexpected behavior

a commenter on the blog mentioned that there's weird behavior when self_contained=FALSE is used. need to poke at this.

I am an idiot - TOC

Get TOC back as a parameter and get it supported in all the templates.

Figure captions

Hi, thanks for the great templates. I'm new to markdown and when I add an image from a file I don't seem to be able to have the caption displayed (it works with the standard markdown templates such as Bioconductor template). Is there a way to change this?
Thanks

Print out Hugo shortcodes

In my Rmd file for Hugo output I am trying to print out a shortcode which looks like this:
{{< highlight >}}.
I tried a couple of ways:

{r chunk, echo=FALSE, results='asis'}
cat("{{< highlight >}}")

but this produces {{< highlight >}} when rendered.

On the other hand, if I use

{r chunk, echo=FALSE}
cat("{{< highlight >}}")

I get:

## {{< highlight >}}

So, neither approach renders the Hugo shortcode properly.

I apologize if this is a rmarkdown/knitr/pandoc question, but was hoping that you had come across this with Hugo and could point me in the right direction.

I got `Error in shell.exec(url)` error

I got Error in shell.exec(url) error and it says .html not found. Any help? Thanks.

Can I use 'toc' function in those templates

Hi, I'm a newer of R markdown.
Can I use 'toc' function in those templates?
I Followed the Definitive Guide book, something like:

output:
html_document:
toc:ture
toc_depth:3

kube source code blocks seem to be "off"

Might need to tweak CSS for code blocks in kube (run template Rmd or see the example image in README.md)

Skeleton navlink broken

There seems to be some accidental HTML escaping in the navlink code.

Example result:

HTML source of affected area:

<div class="hdr u-max-full-width"><a href="&lt;a href=" http: stats.jemu.name qm" class="uri">http://stats.jemu.name/qm</a>&quot;&gt;QM Aufgaben</a></div>

YAML used:


---
title: "Title"
author: "Jemus42"
navtitle: "QM Aufgaben"
navlink: "http://stats.jemu.name/qm"
date: "`r Sys.Date()`"
output: markdowntemplates::skeleton

---

Version:
markdowntemplates 0.3.2.9000 2016-02-06 Github (hrbrmstr/markdowntemplates@33b2ed5)

Skeleton template does not prefill YAML with footer link

IMHO the template should tell me how to change the footer links.

Alternatively, the default template should probably not add two dummy links in the footer.

Hugo: YAML not rendered in ouput md file

I am sure there is a reason why you left out the preserve_yaml argument in the md_document function in hugo.R, but am wondering if there might be a way to set additional values in the front matter of the Rmd file that are preserved for use in Hugo.