Skip to content
forked from r-lib/pkgdown

Generate static html documentation for an R package

Notifications You must be signed in to change notification settings

edwindj/staticdocs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

staticdocs

staticdocs provides a way to conveniently render R package documentation into html pages suitable for stand-alone viewing, such as on a package webpage.

See the staticdocs documentation rendered with staticdocs at http://hadley.github.com/staticdocs/

Features

  • Attractive defaults: staticdocs uses bootstrap to provide an attractive website that you can easily customise.

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

Compared to Rd2html, staticdoc:

  • Makes it easier to customise the output

  • Renders examples, so users see both input and output

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

About

Generate static html documentation for an R package

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 57.2%
  • JavaScript 24.8%
  • R 18.0%