| Type: | Package |
| Title: | Minimal and Uncluttered Package Documentation |
| Version: | 1.4.1 |
| Description: | Generates simple and beautiful one-page HTML reference manuals with package documentation. Math rendering and syntax highlighting are done server-side in R such that no JavaScript libraries are needed in the browser, which makes the documentation portable and fast to load. |
| License: | MIT + file LICENSE |
| URL: | https://ropensci.r-universe.dev/postdoc https://docs.ropensci.org/postdoc/ |
| BugReports: | https://github.com/ropensci/postdoc/issues |
| Encoding: | UTF-8 |
| Imports: | curl, jsonlite, katex (≥ 1.5.0), prismjs, xml2 |
| RoxygenNote: | 7.3.2.9000 |
| Language: | en-US |
| NeedsCompilation: | no |
| Packaged: | 2025-04-13 14:15:02 UTC; jeroen |
| Author: | Jeroen Ooms  [aut,
cre] |
| Maintainer: | Jeroen Ooms <jeroenooms@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2025-04-13 14:30:02 UTC |
Generate HTML reference manual
Description
Renders complete package reference manual in HTML format.
Usage
render_package_manual(package, outdir = ".", link_cb = r_universe_link)
render_base_manuals(outdir = ".")
r_universe_link(package)
Arguments
package |
name of the package |
outdir |
where to put the html file |
link_cb |
callback function which can be used to customize hyperlinks to
other packages. This function gets invoked when a help file contains links to
another package, and should return the URL to the html reference manual for
this other package. Set to |
Details
Math rendering and syntax highlighting are done server-side in R such that no JavaScript libraries are needed in the browser, which makes the documents portable and fast to load.
Value
path to the generated html document
Examples
htmlfile <- render_package_manual('compiler', tempdir())
if(interactive()) utils::browseURL(htmlfile)