https://github.com/davidruvolo51/rdconvert
Converting Rd files to markdown for use in your favorite static site generator
https://github.com/davidruvolo51/rdconvert
gatsby-template package-development r rmarkdown rmarkdown-websites workflow
Last synced: 3 months ago
JSON representation
Converting Rd files to markdown for use in your favorite static site generator
- Host: GitHub
- URL: https://github.com/davidruvolo51/rdconvert
- Owner: davidruvolo51
- License: mit
- Created: 2020-10-16T19:17:30.000Z (over 4 years ago)
- Default Branch: prod
- Last Pushed: 2020-10-21T16:40:19.000Z (over 4 years ago)
- Last Synced: 2025-01-13T18:46:17.125Z (4 months ago)
- Topics: gatsby-template, package-development, r, rmarkdown, rmarkdown-websites, workflow
- Language: R
- Homepage: https://davidruvolo51.github.io/rdConvert/
- Size: 5.16 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rdConvert
**rdConvert** is an R package for creating a package documentation site using [Gatsby JS](https://www.gatsbyjs.com) 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](https://github.com/rocketseat/gatsby-themes).
See the [rdConvert package documentation](https://davidruvolo51.github.io/rdConvert/) for more information on how to integrate `rdConvert` into your current projects, as well as view an example site.
## Usage
Install `rdConvert` using `devtools` or `remotes`.
```r
remotes::install_github("davidruvolo51/rdConvert")
```
For information and examples on customizing your site, see the [Rocket Docs documentation](https://github.com/rocketseat/gatsby-starter-rocket-docs).
## To Do
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
- [x] Improve formatting of Rd content (specifically markdown tables)
- [x] Investigate / integrate markdown formatters (wrote basic regex)
- [x] Integration with a Gatsby template