Git Product home page Git Product logo

staticdocs's Introduction

staticdocs

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 http://staticdocs.had.co.nz/dev/: 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")
devtools::install_github("hadley/staticdocs")

Features

  • Attractive defaults: staticdocs uses [bootstrap] (http://twitter.github.com/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.

staticdocs's People

Contributors

hadley avatar wch avatar jranke avatar adrtod avatar renozao avatar jcheng5 avatar andrie avatar randy3k avatar gaborcsardi avatar ryanhope avatar njahn82 avatar

Watchers

Matt Pollock avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.