Convert elements of roxygen documentation to markdown
R
Latest commit 0ecbe26 Feb 9, 2017 @krlmlr krlmlr safer parsing of links
Permalink
Failed to load latest commit information.
R safer parsing of links Feb 9, 2017
inst/rstudio RStudio add-in Nov 24, 2016
man return changed files invisibly Feb 3, 2017
.Rbuildignore add API Feb 3, 2017
.gitignore infra Nov 16, 2016
API add API Feb 3, 2017
DESCRIPTION document Feb 9, 2017
NAMESPACE first draft Nov 16, 2016
NEWS.md again Feb 3, 2017
README.md fix installation instruction, closes #2 Feb 8, 2017
roxygen2md.Rproj infra Nov 16, 2016

README.md

roxygen2md

The goal of roxygen2md is to replace Rd syntax with Markdown in your package's roxygen2 documentation. Currently, the following substitutions are carried out:

  • \code{\link{...}} becomes [...()]
  • \code{\link[...]{...}} becomes [...::...()]
  • \code{...} becomes `...`

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.

More to come. The substitutions are not completely safe, please carefully examine the results!

Let me know if this works with your documentation.

Installation

Install from GitHub using

# install.packages("roxygen2")
# install.packages("remotes")
remotes::install_github("r-pkgs/roxygen2md")

Usage

In your package directory, run

roxygen2md::roxygen2md()

If you are using RStudio, simply choose the item "Rd to Markdown" from your "Addins" menu.


GPL-3 © Kirill Müller