https://github.com/ropensci/postdoc
Simple HTML package documentation
https://github.com/ropensci/postdoc
Last synced: 3 months ago
JSON representation
Simple HTML package documentation
- Host: GitHub
- URL: https://github.com/ropensci/postdoc
- Owner: ropensci
- License: other
- Created: 2022-11-22T14:46:14.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-09T17:49:36.000Z (5 months ago)
- Last Synced: 2024-09-09T21:57:48.652Z (5 months ago)
- Language: R
- Homepage:
- Size: 30.3 KB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - ropensci/postdoc - Simple HTML package documentation (R)
README
# postdoc
> Simple and Uncluttered Package Documentation
## Installation
You can install the development version of postdoc from r-universe:
```r
# Download and install postdoc in R
install.packages('postdoc',
repos = c('https://ropensci.r-universe.dev','https://cloud.r-project.org'))
```
## Example
Render the manual for the 'MASS' package:
```r
library(postdoc)
htmlfile <- render_package_manual(package = 'MASS')
utils::browseURL(htmlfile)
```