htmlwidgets wrapper for highlight.js
Switch branches/tags
Nothing to show
Clone or download
Filip Stachura
Latest commit c347aca Dec 14, 2016

README.md

highlighter

htmlwidgets wrapper for highlight.js

This package is an htmlwidget wrapper for an excelent highlight.js library. You can learn more about javascript library https://highlightjs.org/.

For now it only support R code chunks.

Source code

This library source code can be found on Appsilon Data Science's Github:
https://github.com/Appsilon/highlighter

<script> document.write('
Appsilon Data Science
') </script>

How to install?

Note! This library is still in its infancy. Api might change in the future.

At the moment it's possible to install this library through devtools.

devtools::install_github("Appsilon/highlighter")

To install previous version you can run:

devtools::install_github("Appsilon/highlighter", ref = "0.1.0")

Example

highlighter::highlight("
  delays <- flights %>% 
    group_by(dest) %>% 
    summarise(
      count = n(),
      dist = mean(distance, na.rm = TRUE),
      delay = mean(arr_delay, na.rm = TRUE)
    ) %>% 
    filter(count > 20, dest != 'HNL')
", width = "400px", height = "200px")

How to contribute?

If you want to contribute to this project please submit a regular PR, once you're done with new feature or bug fix.

Changes in documentation

Both repository README.md file and an official documentation page are generated with Rmarkdown, so if there is a need to update them, please modify accordingly a README.Rmd file and run a build_readme.R script to compile it.

Troubleshooting

We used the latest versions of dependencies for this library, so please update your R environment before installation.

However, if you encounter any problems, try the following:

  1. Up-to-date R language environment

Future enhacements

  • CRAN release
  • Support for other languages
  • Support for other themes

Appsilon Data Science

<script> document.write('
We Provide End-to-End Data Science Solutions
Appsilon Data Science
'); </script>

Get in touch dev@appsilondatascience.com

<script> document.write('Fork me on GitHub') </script>