rdConvert is an R package for creating a package documentation site using Gatsby JS or your preferred web framework. Included in this package, is a workflow for converting Rd files to markdown using the code documentation started developed by RocketSeat.
See the rdConvert package documentation for more information on how to integrate rdConvert into your current projects, as well as view an example site.
Install rdConvert using devtools or remotes.
remotes::install_github("davidruvolo51/rdConvert")For information and examples on customizing your site, see the Rocket Docs documentation.
This package is experimental and will likely change. I would like to add the following features.
- The ability to customize the YAML
- Improve directory and file validation
- Customize the destination structure
- Improve formatting of Rd content (specifically markdown tables)
- Investigate / integrate markdown formatters (wrote basic regex)
- Integration with a Gatsby template