Skip to content

A refence docx file for pandoc with solarized syntax highlighting

License

GPL-3.0, GPL-3.0 licenses found

Licenses found

GPL-3.0
LICENSE
GPL-3.0
LICENSE.md
Notifications You must be signed in to change notification settings

tjmahr/solarizeddocx

Repository files navigation

solarizeddocx

R-CMD-check

Comparison of the solarized document theme versus the default theme.

solarizeddocx provides an RMarkdown output format to create a docx file with solarized syntax highlighting. It works by provide custom style files to pandoc.

Currently only the light solarized theme is supported.

Installation

You can install the development version of solarizeddocx from GitHub with:

# install.packages("devtools")
devtools::install_github("tjmahr/solarizeddocx")

Usage

This format can be used via YAML metadata.

output: 
  solarizeddocx::document: default

Or explicitly with rmarkdown:

rmarkdown::render(
  "README.Rmd", 
  output_format = solarizeddocx::document()
)

Customization

The built-in demo function will render a vignette detailing all of the customizations used by the package.

solarizeddocx::demo_document()

Assets

This format’s styling assets can be accessed by the included file_ functions. For example, here is how one could sneak this format’s solarized theme into an HTML document.

rmarkdown::render(
  "README.Rmd", 
  output_format = rmarkdown::html_document_base(
    pandoc_args = rmarkdown::pandoc_highlight_args(
      solarizeddocx::file_solarized_light_theme()
    ) 
  )
)

About

A refence docx file for pandoc with solarized syntax highlighting

Resources

License

GPL-3.0, GPL-3.0 licenses found

Licenses found

GPL-3.0
LICENSE
GPL-3.0
LICENSE.md

Stars

Watchers

Forks

Packages

No packages published

Languages