preview_docs: Preview the documentation in a webpage or in viewer
In altdoc: Package Documentation Websites with 'Quarto', 'Docsify', 'Docute', or 'MkDocs'
preview_docs R Documentation
Preview the documentation in a webpage or in viewer
Description
Preview the documentation in a webpage or in viewer
Usage
preview_docs(path = ".")
Arguments
path
Path to the package root directory.
Value
No value returned. If RStudio is used, it shows a site preview in
Viewer. To preview the site in a browser or in another text editor (ex: VS Code),
see the vignette on the altdoc website.
Examples
if (interactive()) {
preview_docs()
}
# This is an example to illustrate that code-generated images are properly
# displayed. See the `altdoc` website for a rendered version.
with(mtcars, plot(mpg, wt))
altdoc documentation built on April 3, 2025, 10:52 p.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.
| preview_docs | R Documentation |
Preview the documentation in a webpage or in viewer
Description
Preview the documentation in a webpage or in viewer
Usage
preview_docs(path = ".")
Arguments
path |
Path to the package root directory. |
Value
No value returned. If RStudio is used, it shows a site preview in
Viewer. To preview the site in a browser or in another text editor (ex: VS Code),
see the vignette on the altdoc website.
Examples
if (interactive()) {
preview_docs()
}
# This is an example to illustrate that code-generated images are properly
# displayed. See the `altdoc` website for a rendered version.
with(mtcars, plot(mpg, wt))
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.