'Roxygen' to 'Markdown'
Converts elements of 'roxygen' documentation to 'markdown'.
The goal of roxygen2md is to replace Rd syntax with Markdown
in your package's
Currently, the following substitutions are carried out:
DESCRIPTION is edited to enable Markdown in roxygen blocks.
roxygen2 version 6.0.0 or later.
roxygen2md::roxygen2md() in your package's directory, or navigate to "Tools/Addins/Rd to Markdown" in RStudio.
More to come. The substitutions are not completely safe, please carefully examine the results!
Let me know if this works with your documentation.
Install from GitHub using
# install.packages("roxygen2") # install.packages("remotes") remotes::install_github("r-pkgs/roxygen2md")
In your package directory, run
If you are using RStudio, simply choose the item "Rd to Markdown" from your "Addins" menu.
GPL-3 © Kirill Müller
Functions in roxygen2md
|roxygen2md||Convert from Rd to Markdown in roxygen2 comments|
|Roxygen||list(markdown = TRUE, roclets = c("rd", "namespace", "pkgapi::api_roclet"))|
Include our badge in your README