README.md

hyderogen

Turn your roxygen documentation into a jekyll site.

How it works

• one page per package function or object or named section
• example sections support a simple templating system for readable docs offline and online
• generates folder structure under docs/ and builds site at docs/_site/
• simple sidebar layout, styled with Bootstrap

# remotes::install_github("nteetor/hyderogen")

library(hyderogen)

# WARNING ----
# In its current state this function will delete any existing files
# in your docs/ folder!!
jekyll("<path to pkg>", build = TRUE)

Examples section templating

#' @examples
#'
#' ### This is converted into a title
#'
#' # This is converted into a paragraph.
#' # This is in the same paragraph.
#'
#' div("hello, world")
#'
#' % <div>another div</div><!--this is dropped in verbatim-->
#'
#' # A final pararaph.

Code blocks, the div("hello, world"), are evaluated such that the code and output are both shown.

Why?

It's a toolset useful to me and I like jekyll.