{"repo":"r-lib/roxygen2md","free":true,"listed":false,"github":"https://github.com/r-lib/roxygen2md","clone":"git clone https://github.com/r-lib/roxygen2md.git","description":"Convert elements of roxygen documentation to markdown","language":"R","stars":69,"topics":["r","documentation","markdown"],"license":null,"category":"docs-static-sites","readme_excerpt":"roxygen2md The goal of roxygen2md is to replace Rd syntax with Markdown in your package’s roxygen2 documentation. The following Rd code is converted to the Markdown equivalent: - \\emph{} - \\bold{} and \\strong{} - \\href{} - \\url{} - \\code{...} - Various variants of \\code{\\link{...}} and \\code{\\link[...]{...}} (only with scope = \"full\" , see below) If necessary, DESCRIPTION is edited to enable Markdown in roxygen blocks. You’ll need roxygen2 version 6.0.0 or later. Call roxygen2md::roxygen2md() in your package’s directory, or navigate to “Tools/Addins/Rd to Markdown” in RStudio. The substitutions are not completely safe, please carefully examine the results! Installation Install from CRAN using Get the latest development version from GitHub with: Usage In your package directory, run If you are using RStudio, choose the item “Rd to Markdown” from your “Addins” menu. You will be guided through the process. At any time, choose the item “Find Rd” from your “Addins” menu, or run find rd() , to enumerate Rd elements in your R scripts. Converting large packages For larger existing packages, a three-stage workflow is recommended, using roxygen2md(scope = \"none\") , \"simple\" and \"full\" in sequence: - \"none\" only adds list(markdown = TRUE) to the Roxygen field in DESCRIPTION - \"simple\" only converts elements like \\code{} and \\emph{} - \"full\" runs all conversions - \"unlink\" splits complicated \\code{} tags with embedded \\link{} This helps isolating mostly automated changes from changes that","default_branch":null,"files":null,"tree":[],"storefront":"/r/r-lib","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/r-lib/roxygen2md/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}