RDocumentation 2.0

Note: Please read this confluence page which explains the architecture of how RDocumentation works, and how to run the backend locally.

Available at:

https://rdocumentation.org

Internally:

https://rdocumentation.us-east-1.internal.datacamp-staging.com/

RDocumentation provides an easy way to search the documentation for every version of every R package on CRAN and Bioconductor.

Setup

To run locally, clone this repo and cd into the directory.

Create a .env.local file at the root of the repository. Since RDocumentation fetches data from the GitHub API, you'll need to create a GitHub personal access token (with public_repo scope) and add it as an environment variable.

GITHUB_TOKEN=YOUR_PERSONAL_ACCESS_TOKEN

Then run the following to install dependencies and start the development server on http://localhost:3000:

nvm use
yarn
yarn dev

Contributing

We welcome all sorts of contributions, be it new features, bug fixes or documentation, we encourage you to create a new PR. To create a new PR or to report new bugs, please read how to contribute to RDocumentation.

Stack

This website was built by Nick Carchedi using Next.js, Tailwind CSS and DataCamp's own Waffles component library. We ❤️ open source.