https://github.com/nteetor/hyderogen

Build jekyll sites from roxygen
https://github.com/nteetor/hyderogen

jekyll r roxygen2

Last synced: 2 days ago
JSON representation

Build jekyll sites from roxygen

• Host: GitHub
• URL: https://github.com/nteetor/hyderogen
• Owner: nteetor
• License: other
• Created: 2018-04-15T20:15:04.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-29T05:23:02.000Z (almost 5 years ago)
• Last Synced: 2024-08-13T07:13:06.287Z (3 months ago)
• Topics: jekyll, r, roxygen2
• Language: R
• Homepage:
• Size: 69.3 KB
• Stars: 7
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - nteetor/hyderogen - Build jekyll sites from roxygen (R)

README

        
# hyderogen

![stability-wip](https://img.shields.io/badge/stability-work_in_progress-blue.svg)

Turn your roxygen documentation into a jekyll site.

## How it works

- [x] one page per package function or object or named section

- [x] example sections support a simple templating system for readable docs

  offline and online

- [x] generates folder structure under `docs/` and builds site at `docs/_site/`

- [x] simple sidebar layout, styled with Bootstrap

```R

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

library(hyderogen)

# WARNING ----

# In its current state this function will delete any existing files

# in your docs/ folder!!

jekyll("", build = TRUE)

```

## Examples section templating

```R

#' @examples

#'

#' ### This is converted into a title

#'

#' # This is converted into a paragraph.

#' # This is in the same paragraph.

#'

#' div("hello, world")

#'

#' % 
another div

#'

#' # 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.