README.md
In Paradigm4/pkgdown: Make Static HTML Documentation for a Package
pkgdown
Forked R pkgdown library
Reason of forking:
The original pkgdown package doesn't allow paged data frame rendering.
Installation
# Install development version from GitHub
devtools::install_github("Paradigm4/pkgdown")
Usage
Get started with usethis:
# Run once to configure your package to use pkgdown
usethis::use_pkgdown()
Use pkgdown to update your website:
# Run to build the website
pkgdown::build_site()
This generates a docs/ directory containing a website. Your
README.md becomes the homepage, documentation in man/ generates a
function reference, and vignettes will be rendered into articles/.
Read vignette("pkgdown") for more details and to learn how to
customise your site.
Overwrite rules
Any extra assets for the generated static site should placed inside R_package_root/pkgdown/ prefixed with extra, e.g. extra.css.
Paradigm4/pkgdown documentation built on June 3, 2020, 12:30 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
pkgdown
Forked R pkgdown library
Reason of forking:
The original pkgdown package doesn't allow paged data frame rendering.
Installation
# Install development version from GitHub
devtools::install_github("Paradigm4/pkgdown")
Usage
Get started with usethis:
# Run once to configure your package to use pkgdown
usethis::use_pkgdown()
Use pkgdown to update your website:
# Run to build the website
pkgdown::build_site()
This generates a docs/ directory containing a website. Your
README.md becomes the homepage, documentation in man/ generates a
function reference, and vignettes will be rendered into articles/.
Read vignette("pkgdown") for more details and to learn how to
customise your site.
Overwrite rules
Any extra assets for the generated static site should placed inside R_package_root/pkgdown/ prefixed with extra, e.g. extra.css.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.