Skip to content

Releases: r-lib/roxygen2md

roxygen2md 1.0.0

01 Oct 09:57
Compare
Choose a tag to compare

Initial release.

  • Function roxygen2md() that can be run in the package's directory and converts all roxygen2 comments to Markdown, guiding the user with helpful output.
    • The DESCRIPTION is edited if necessary, or a message is given that the user should edit themselves.
    • Runs document() automatically if markdown = TRUE in DESCRIPTION.
    • Perform only partial conversion by specifying the scope argument.
    • Makes use of usethis::proj_get().
  • Function find_rd() to find the remaining Rd syntax
  • Function markdownify() converts Rd to Markdown in character vectors (#10, @alexpghayes).
  • RStudio add-in with menu items "Rd to Markdown" and "Find Rd.