Skip to content
This repository

Generate static html documentation for an R package

branch: master

Merge pull request #63 from randy3k/code

wrong close tag for <pre>
latest commit 2cbd23d3ba
Hadley Wickham authored
Octocat-spinner-32 R code should be pre
Octocat-spinner-32 demo Fix demo index
Octocat-spinner-32 inst New way of specifying settings
Octocat-spinner-32 man Consistent use of as.sd_package.
Octocat-spinner-32 vignettes Tweaking spacing
Octocat-spinner-32 .Rbuildignore Add travis
Octocat-spinner-32 .gitignore Add rstudio project
Octocat-spinner-32 .travis.yml Add some binary installs
Octocat-spinner-32 DESCRIPTION New way of specifying settings
Octocat-spinner-32 LICENSE Remove extra devtools and add LICENSE
Octocat-spinner-32 NAMESPACE handle @describe tag properly
Octocat-spinner-32 Improve readme
Octocat-spinner-32 staticdocs.Rproj Add rstudio project


Build Status

staticdocs provides a way to conveniently render R package documentation into html pages suitable for stand-alone viewing, such as on a package webpage. You can see staticdocs in action at this is the output of staticdocs applied to the latest version of staticdocs.

staticdocs is not currently available from CRAN, but you can install the development version from github with:

# install.packages("devtools")


  • Attractive defaults: staticdocs uses bootstrap to provide an attractive website.

  • Customisable: you can override the default templates to provide alternative rendering

  • Flexible ways to specify the index page so you can group related functions together.

Compared to Rd2html, staticdocs:

  • Makes it easier to customise the output.

  • Runs examples, so users see both input and output.

  • Assumes only one package is being rendered - links to documentation in other packages are forwarded to inside-R.

Something went wrong with that request. Please try again.