Git Product home page Git Product logo

highlight's Introduction

highlight

highlight is a syntax highlighter for R code.

Installation

You can install highlight from github with:

# install.packages("devtools")
devtools::install_github("romainfrancois/highlight")

Typical highlighting (lestrade)

Typical syntax highlighting is only interested in whether a token is a function call, a keyword, a string, ... this is what the lestrade detective does:

highlight( file = "css_file.R", detective = lestrade )

This will look like this:

This differentiates function calls, formal arguments, used arguments ... because lestrade identified these tokens as such.

semantic highlighting (sherlock)

Traditional highlighting only reveals the obvious, so the package also benefits from the investigation of sherlock for semantic highlighting. In semantic highlighting, every symbol gets a different color.

highlight( file = "css_file.R", detective = sherlock )

With this we can quickly skim through the file and see e.g. the different uses of filename.

In rmarkdown

To use in rmarkdown you can use the hl_hook_source and hl_hook_document hooks. Unfortunately this does not work for README on github so this document uses screenshots.

knitr::knit_hooks$set( 
  source = hl_hook_source, 
  document = hl_hook_css
)

highlight's People

Contributors

romainfrancois avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.